Preguntas etiquetadas con api

Tenemos como 20-30 módulos / soluciones independientes. Cada uno de estos tiene entre 7 y 10 proyectos con diferentes clases, componentes, etc. Todos estos se utilizan internamente en nuestra empresa. Nuestro problema es que cuando hacemos un cambio en un módulo, debemos asegurarnos de actualizar todos los demás módulos que …

8 documentation  api  configuration-management  change-management 

Estoy diseñando un sistema para un cliente donde los requisitos son: suben un archivo JSON (un objeto / línea) hacer una llamada a una API con el objeto JSON como carga útil registrar el estado (éxito / fracaso) de cada llamada API en una base de datos vuelva a intentarlo …

8 database  python  api  scheduling  rabbitmq 

Mi pregunta es sobre las mejores prácticas de agregar o agrupar API REST. Tengo un escenario en el que hay muchos proveedores diferentes, fuentes de datos, etc. y creo que agrupar las API REST tendría mucho sentido para mantener el sistema mantenible. Tengo muchos escenarios en los que habrá una …

8 architecture  rest  api 

Estoy creando una API que utilizará tokens de acceso para poder rastrear el uso entre varios departamentos y para el control de acceso. Mi plan es utilizar los verbos HTTP de manera adecuada: GETrecuperará información, POSTagregará, DELETEeliminará, etc. Mi pregunta es, ¿cómo debo manejar los tokens de acceso en las …

8 design  design-patterns  api  api-design 

Imagine que tiene un módulo de software, que es un complemento de algún programa (similar a Eclipse) y desea que tenga una API que otros complementos puedan llamar. Su complemento no está disponible de forma gratuita, por lo que desea tener un módulo API separado, que está disponible gratuitamente y …

8 java  api 

Estoy creando una API RESTful simple para una aplicación basada en la web en la que estoy trabajando, y me pregunto cuál es la mejor manera de exponer mis modelos de dominio. Digamos que tengo una clase de usuario y quiero proporcionar una respuesta JSON con las diversas propiedades del …

8 language-agnostic  api  domain-model 

Estoy tratando de documentar una pieza de software que escribí en detalle. Un SAS tiene un nivel demasiado alto y no cubre la API. Encontré varios ejemplos de una SDS en línea, pero no veo una tendencia en su formato. Me pregunto si hay algunas pautas generales para escribir una …

8 documentation  api  uml  design 

En el proyecto en el que estoy trabajando, enviamos mensajes sobre widgets a través de colas de mensajes, serializándolos en las colas como XML. El esquema XML contiene etiquetas para propiedades que son comunes a todos los tipos de estos mensajes de widget, como el tipo de widget, el nombre …

8 object-oriented  api  api-design 

Al diseñar una API que proporciona una interfaz de escucha de eventos, parece que hay dos formas conflictivas de tratar las llamadas para agregar / quitar escuchas: Múltiples llamadas a addListener solo agregarán un único oyente (como agregarlo a un conjunto); se puede eliminar con una sola llamada a removeListener. …

8 design-patterns  api 

Pregunta: Para una API web pública (envíe solicitudes HTTP Get / Post, recupere datos JSON / XML), cómo deben manejarse los parámetros que están mal escritos o son extra. Me parece que si se ignoran los parámetros incorrectos, un error en el código de la persona que llama puede pasar …

8 api  error-handling 

Se habla sobre la sintaxis y la característica que le gusta en un lenguaje de programación; ahora le preguntaré qué principios o características principales le gustaría tener en una biblioteca en su idioma favorito (o cualquier otro). Un ejemplo es tener agregar list + = anotherList válido como opuesto a …

8 design  libraries  api  interfaces 

Actualmente estoy trabajando en un proyecto, donde tengo que analizar los requisitos de dos sistemas de TI dados, que usan la computación en la nube, para una API en la nube. En otras palabras, tengo que analizar qué requisitos tienen estos sistemas para una API en la nube, de modo …

8 documentation  api 

Para una API REST en la que estoy trabajando, quiero devolver JSON en un diseño consistente: { "Data" : { "Id" : 123, "Email" : "charlie@somewhere.com" "Firstname" : "Charlie", "Surname" : "Brown", }, "Error" : null } La carga siempre contendrá "Datos" y "Error", donde uno u otro puede ser …

8 api  rest  json