Preguntas etiquetadas con api-design

Estoy trabajando en envolver una API de C ++ que proporciona acceso a un almacén de datos (Hazelcast) en funciones C, para que también se pueda acceder al almacén de datos desde el código C-only. La API de Hazelcast C ++ para la estructura de datos del mapa tiene este …

9 c++  c  api-design 

Digamos que tiene algún tipo de estructura de datos, que persiste en algún tipo de base de datos. Por simplicidad, llamemos a esta estructura de datos Person. Ahora tiene la tarea de diseñar una API CRUD, que permite a otras aplicaciones crear, leer, actualizar y eliminar correos electrónicos Person. Para …

9 design  api  web-services  api-design  crud 

Por lo general, los oyentes de eventos no deberían sobrevivir a los objetos que los registraron. ¿Significa que los oyentes de eventos deberían estar sujetos a referencias débiles por defecto (almacenadas en colecciones débiles por las que los oyentes objeto están registrados)? ¿Hay casos válidos en los que el oyente …

9 api-design  event 

Suponga que tiene un gran proyecto respaldado por una base API. El proyecto también incluye una API pública que los usuarios finales (ish) pueden usar. En ocasiones, debe realizar cambios en la base de API que admite su proyecto. Por ejemplo, debe agregar una función que necesite un cambio de …

9 versioning  api-design 

Digamos que tengo lo siguiente: package me.my.pkg; public interface Something { /* ... couple of methods go here ... */ } y: package me.my; import me.my.pkg.Something; public class SomeClass implements Something { /* ... implementation of Something goes here ... */ /* ... some more method implementations go here too …

9 java  api-design  patterns-and-practices  anti-patterns 

Por favor, resuelva una discusión entre un amigo y yo. Actualmente estamos diseñando una API de producto. Nuestra entidad de producto se ve así { "Id": "", "ProductName": "", "StockQuantity": 0 } Las ventas de productos son manejadas por un tercero y están obligadas a informarnos con la cantidad comprada …

8 design  design-patterns  rest  api-design  rpc 

Creo que uno de los mayores puntos débiles al trabajar con microservicios es asegurarse de que las API estén bien documentadas y que las API no cambien su comportamiento sin afectar las aplicaciones posteriores. Este problema se amplifica cuando tiene muchos servicios que son interdependientes entre sí. Quizás en ese …

8 api-design  documentation  microservices 

Al diseñar un servicio web RESTful, ¿se debe diseñar la API para que funcione la ID de las cadenas de valores que se transmiten de un lado a otro entre el servidor? Aquí hay un ejemplo: Digamos que tengo un recurso de empleado, que tiene un estado y atributos de …

8 rest  api-design  json 

Del comentario de Roy Fielding sobre su propio artículo denunciando falsas API REST : Una API verdaderamente RESTful parece hipertexto. Cada unidad de información direccionable lleva una dirección, ya sea explícitamente (p. Ej., Atributos de enlace e identificación) o implícitamente (p. Ej., Derivada de la definición del tipo de medio …

8 rest  api  api-design 

Esta pregunta me ha molestado durante unos días y parece que varias prácticas se contradicen entre sí. Ejemplo Iteración 1 public class FooDao : IFooDao { private IFooConnection fooConnection; private IBarConnection barConnection; public FooDao(IFooConnection fooConnection, IBarConnection barConnection) { this.fooConnection = fooConnection; this.barConnection = barConnection; } public Foo GetFoo(int id) { …

8 c#  unit-testing  api-design  dependency-injection  solid 

En el pasado, utilizaba la forma estándar de agregar @Deprecatedanotaciones a los métodos API que se eliminarán en una versión posterior. Ahora estoy preparando una versión principal para una biblioteca, con muchas partes de API eliminadas y renombradas. Para facilitar la transición a los usuarios existentes, tal vez podría ser …

8 java  api-design  libraries  versioning 

Estoy viendo que cada vez más API nuevas usan tokens de página para permitir al usuario moverse entre las páginas de resultados que contienen muchos elementos. Sin embargo, desde el punto de vista del diseñador de API, no tengo claro cuáles son los beneficios de usar un token en comparación …

8 programming-practices  rest  api-design 

En nuestra API tenemos algunos tipos de datos centrales que deben ser "decorados" (por así decirlo) después de la recuperación de la base de datos con valores calculados. Se accede a la base de datos a través de un ORM que sigue una dinámica de tabla / entidad fuertemente inspirada …

8 database  data-structures  functional-programming  api-design  orm 

En una aplicación principal REST API que cubre varios dominios relacionados, ¿tiene más sentido dividir los recursos en 'áreas' en función del dominio empresarial al que pertenecen o es mejor mantener un solo modelo? Por ejemplo, hay subdominios de 'Ventas' e 'Inventario'. Los usuarios del sistema generalmente solo se preocupan …

8 architecture  rest  api-design 

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