Preguntas etiquetadas con api-design

Tuve una acalorada discusión hoy sobre nuestra aplicación MVC. Tenemos un sitio web escrito en MVC ( ASP.NET ), y generalmente sigue el patrón de hacer algo en la vista -> presionar el controlador -> el controlador construye un modelo (llama a un administrador que obtiene los datos, construye el …

322 mvc  asp.net-mvc  api-design 

Estoy tratando de descubrir qué significa realmente la capa anticorrupción. Sé que es una forma de hacer la transición / evitar código heredado o API incorrectas. Lo que no entiendo es cómo funciona y qué lo hace una separación limpia de la capa indeseable. He realizado algunas búsquedas, pero no …

151 design-patterns  api-design  legacy  bad-code 

Al diseñar una interfaz RESTful, la semántica de los tipos de solicitud se considera vital para el diseño. GET - Lista de colección o elemento de recuperación PUT - Reemplazar colección o elemento POST - Crear colección o elemento BORRAR - Bueno, erm, eliminar colección o elemento Sin embargo, esto …

137 design  rest  api-design  http-request 

Digamos que tengo una entidad que tiene el atributo "type". Podría haber más de 20 tipos posibles. Ahora me piden que implemente algo que permita cambiar el tipo de A-> B, que es el único caso de uso. Entonces, ¿debo implementar algo que permita cambios de tipo arbitrarios siempre que …

124 programming-practices  api-design  requirements 

Digamos que tengo un punto final REST que toma un entero como parámetro: /makeWaffles?numberOfWaffles=3 En este caso, quiero que el número sea positivo porque no puedo hacer un número negativo de gofres (y solicitar 0 gofres es una pérdida de tiempo). Por lo tanto, quiero rechazar cualquier solicitud que no …

56 api-design  http 

Digamos que está codificando una función que toma datos de una API externa MyAPI. Esa API externa MyAPItiene un contrato que establece que devolverá a stringo a number. ¿Se recomienda para protegerse contra cosas como null, undefined, boolean, etc, incluso aunque no es parte de la API de MyAPI? En …

51 design  api  api-design  web-services  functions 

Nuestro servicio se encuentra en 5 ciudades en este momento. Si alguien intenta llamar a nuestro API de servicio desde cualquier otra ciudad, queremos lanzar este error Service not available in your area. La pregunta es, ¿cuál sería el código http apropiado para este error? 503 Servicio no Disponible 403: …

51 api  api-design  http 

Actualmente estoy codificando una API para una red social con Slim Framework. Mi pregunta es: ¿Cuáles son las mejores prácticas cuando no hay filas para devolver en la estructura json? Digamos que esta llamada / v1 / get / movies devuelve 2 filas de los nombres de películas de la …

50 programming-practices  rest  api-design  json 

Actualmente estoy trabajando en un proyecto con una organización de la siguiente manera: Cliente : obtiene datos del servidor principal a través de la API REST. Servidor : solicita datos de otros servidores a través de API de terceros API de terceros : servicios fuera de mi control que proporcionan …

49 design  rest  api-design  server 

Me preguntaba acerca de esto. Supongamos que tengo un userrecurso con idy namecampos. Si quiero actualizar un campo, podría hacer una solicitud PATCH al recurso como este PATCH /users/42 {"name": "john doe"} Y luego la aplicación actualizará el nombre del usuario 42. Pero, ¿por qué si repito esta solicitud, el …

48 rest  api-design  http  web-api 

Estoy escribiendo una implementación Java de un juego de cartas, así que creé un tipo especial de Colección que llamo Zona. Todos los métodos de modificación de la Colección de Java no son compatibles, pero hay un método en la API de Zona move(Zone, Card), que mueve una Tarjeta de …

45 java  programming-practices  data-structures  api-design 

Sigo escuchando a la gente (Crockford en particular) decir que el DOM es una API terrible, pero no justifica realmente esta afirmación. Además de las inconsistencias entre navegadores, ¿cuáles son algunas de las razones por las cuales el DOM se considera tan malo?

42 javascript  api  api-design  dom 

Me pregunto por qué java.util.ArrayListpermite agregar null. ¿Hay algún caso en el que me gustaría agregar nulla un ArrayList? Me hago esta pregunta porque en un proyecto que teníamos un error en algún código se agregó nulla la ArrayListy era difícil de detectar dónde estaba el error. Obviamente NullPointerExceptionse arrojó …

41 java  api-design  collections 

Digamos que en mi solicitud, algunos usuarios nos dan su apellido y otros no. En una respuesta REST API, qué cuerpo se prefiere: Con un valor "nulo": {"firstName": "Bob", "lastName": null} O simplemente una clave faltante: {"firstName": "Bob"}

41 rest  api-design  json 

Estoy trabajando con una API REST que reside en un servidor que maneja datos para una multitud de dispositivos IoT. Mi tarea es consultar al servidor utilizando la API para recopilar información de rendimiento específica sobre dichos dispositivos. En un caso, obtengo una lista de dispositivos disponibles y sus identificadores …

39 api-design  error-handling  http-response