Preguntas etiquetadas con api-design

Tenemos una función API que desglosa un monto total en montos mensuales en función de las fechas de inicio y finalización. // JavaScript function convertToMonths(timePeriod) { // ... returns the given time period converted to months } function getPaymentBreakdown(total, startDate, endDate) { const numMonths = convertToMonths(endDate - startDate); return { …

38 api-design 

Cuando se trata de API JSON, ¿es una buena práctica aplanar las respuestas y evitar objetos JSON anidados? Como ejemplo, digamos que tenemos una API similar a IMDb pero para videojuegos. Hay un par de entidades, Juego, Plataforma, ESRBRating y GamePlatformMap que mapean Juegos y Plataformas. Digamos que solicitas / …

38 design  rest  api-design  json 

Estoy proponiendo cambios a un proyecto de software muy mal diseñado que sufre de una multitud de problemas. En un nivel alto, el proyecto utiliza Angular en el front-end y consume varias API REST; lo cual es genial (no veo la necesidad de cambiar nuestra tecnología o herramientas). El problema …

37 rest  api-design  enterprise-architecture 

¿Hay algún tipo de estándar con respecto a las respuestas de la API HTTP? Después de leer este hilo del discurso comencé a preguntarme. Estamos desarrollando nuestra API HTTP JSON pública en mi trabajo, y no devolvemos nada cuando no es estrictamente necesario (por ejemplo, PUT to / resource / …

33 rest  api-design  http 

En una discusión sobre métodos estáticos y de instancia, siempre pienso que ese Sqrt()debería ser un método de instancia de tipos de números en lugar de un método estático. ¿Porqué es eso? Obviamente funciona en un valor. // looks wrong to me var y = Math.Sqrt(x); // looks better to …

31 programming-languages  language-design  history  api-design  math 

Estoy diseñando una aplicación usando Micro-Servicios y no estoy seguro del mejor mecanismo para recolectar datos de múltiples servicios. Creo que hay dos opciones: Integre un mecanismo de comunicación 'entre servicios' que permita que los servicios hablen directamente. API Gateway llamaría a un servicio individual, que luego llama a otros …

30 architecture  api-design  microservices 

Estoy evaluando una biblioteca cuya API pública actualmente se ve así: libengine.h /* Handle, used for all APIs */ typedef size_t enh; /* Create new engine instance; result returned in handle */ int en_open(int mode, enh *handle); /* Start an engine */ int en_start(enh handle); /* Add a new hook …

27 c  api-design  libraries 

Esta pregunta se migró de Stack Overflow porque se puede responder en Software Engineering Stack Exchange. Migrado hace 8 años . Necesito reservar nombres de usuario en mi nuevo sitio web. Estos generalmente se dividen en tres categorías. 1) nombres de usuario que nadie debería tener (por ejemplo: administrador, usuario, …

26 database  design  data  api-design 

Estoy considerando mover una API REST monolítica a una arquitectura de microservicio, y me estoy confundiendo un poco sobre el almacenamiento de datos. A mi entender, algunos de los beneficios de los microservicios serían: Escalable horizontalmente: puedo ejecutar múltiples copias redundantes de un microservicio para hacer frente a la carga …

26 architecture  rest  api-design  microservices 

Al crear una API RESTful , ¿debería usar verbos HTTP en la misma URL (cuando sea posible) o debería crear una URL específica por acción? Por ejemplo: GET /items # Read all items GET /items/:id # Read one item POST /items # Create a new item PUT /items/:id # Update …

25 rest  api-design  web-api 

Cuando se discuten las API entre sistemas (a nivel empresarial), a menudo hay dos puntos de vista diferentes en nuestro equipo: algunas personas prefieren un enfoque abstracto más, digamos, genérico , otro un enfoque "concreto" directo. Ejemplo: el diseño de una API simple de "búsqueda de personas". la versión concreta …

25 api  web-services  api-design 

En mi proyecto actual, soy responsable de la implementación de un servicio que implica el consumo de API RESTful recién creadas, documentadas como únicamente compatibles con JSON. El cliente realiza constantemente solicitudes con el encabezado de aceptación de 'application / json' y el tipo de contenido de 'application / json'. …

25 rest  api-design  json  bad-code 

Tengo una plataforma de rieles que mantengo. Tiene muchas aplicaciones web diferentes creadas sobre él. Sin embargo, ahora un cliente solicita una API para poder mantener a los usuarios en su sitio, pero aprovechar algunas de las tareas automatizadas que tenemos. La plataforma se utiliza para crear aplicaciones de seguros …

25 web-applications  ruby-on-rails  api-design 

Esta pregunta se migró de Server Fault porque se puede responder en Software Engineering Stack Exchange. Migrado hace 6 años . Actualmente estoy implementando una API HTTP, mi primera vez. He pasado mucho tiempo buscando códigos de estado HTTP en la página de Wikipedia, porque estoy decidido a implementar los …

24 api-design  http 

Estoy diseñando una API REST para un proyecto donde los usuarios siempre están en uno de varios "planes": cada plan define algunos límites de recursos, como la cantidad máxima de usuarios que puede tener una cuenta o la cantidad máxima de datos que pueden cargar. Una vez que se alcanza …

24 rest  api-design  http