Preguntas etiquetadas con api-design

MVC es bastante sencillo. Hay un modelo, un controlador y una vista. Cuando creamos un sitio web, todo se junta cuando el cliente envía la solicitud de palabra clave REST al servidor -> el servidor hace coincidir la URL solicitada con la acción del controlador -> que luego llama a …

12 design-patterns  mvc  rest  api  api-design 

En C # si quiero dividir un stringpor otro string, tengo que hacer algo así: testString.Split(new string[] { "anotherString" }, StringSplitOptions.None); A partir de la String.Splitdocumentación sobrecargada de MSDN podemos ver la implementación y por qué se debe realizar dicha llamada. Viniendo de Python , es difícil para mí entender …

11 c#  performance  api-design 

Estoy tratando de convertir un conjunto de servicios basados ​​en SOAP a una API RESTful. Comencé identificando recursos analizando los nombres de las operaciones y obtuve el recurso Subscription. Cuando necesito actualizar el estado de la suscripción, no puedo simplemente enviar una POSTsolicitud al servidor, porque no tengo acceso directo …

11 rest  web-services  api-design  web-api 

Me gustaría crear un sistema que maneje los mensajes de alerta de varios programas y pueda procesar esas alertas a los consumidores con poco viento por correo electrónico. Todo esto estaría contenido en una red interna. Creo que quiero que la arquitectura básica se vea así: La principal preocupación que …

10 design  design-patterns  architecture  api  api-design 

Una de las características propuestas para "Project Coin" de Java 7 fue el "operador de Elvis". Un informe de una presentación de JavaOne de 2009 sobre Project Coin lo describió como tal: Una de las "pequeñas características" cubiertas en esta presentación es el llamado "operador de Elvis", una versión más …

10 java  api-design 

Creamos una biblioteca comercial y ejemplos de código que están siendo utilizados por desarrolladores externos. Tenemos documentación (cerrada, disponible para usuarios registrados) que explica ampliamente cómo usar la biblioteca. Muchos de los desarrolladores son usuarios nuevos, por lo que se encuentran muchos errores rudimentarios. ¿Es apropiado incluir enlaces a la …

10 documentation  api-design  error-handling  error-messages 

Soy nuevo en Java y estaba leyendo su documentación sobre excepciones. , y especialmente las Excepciones no verificadas - La página de controversia . El resultado final dice: Si se puede esperar razonablemente que un cliente se recupere de una excepción, conviértalo en una excepción marcada. Si un cliente no …

10 java  api-design  exceptions 

Dado que los cambios en la firma de API / método público deberían ser mínimos para evitar romper los códigos de clientes que usan estos métodos, me preguntaba si la Ley de Demeter es menos aplicable a estos. Un simple ejemplo: class Account() { double balance; public void debit(Transaction t) …

10 design  api-design 

Cerrada . Esta pregunta está basada en la opinión . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que pueda ser respondida con hechos y citas editando esta publicación . Cerrado hace 4 años . ¿Cuáles son algunos defectos que te vuelven loco en las …

10 c  api-design  pitfalls 

Tengo el siguiente punto final: a/{id}/b y desea crear una solicitud de benvío POST. Si acon dado {id}no se encuentra, ¿debería responder con 404 NOT_FOUNDo tal vez con 409 CONFLICT? Es para manejar sin formato a/{id}, el truco es que aquí se utiliza un subrecurso.

10 rest  api  api-design  http-request 

Tengo que diseñar un "widget", un script que los socios incorporarán en sus sitios web para mostrar una interfaz de usuario y realizar llamadas a nuestra API. Básicamente, mostrará nuestros datos en estos sitios en función de algunos ID que proporcionan en nuestras llamadas a la API. Lo que nos …

10 security  api-design  web-api 

Al analizar la entrada del usuario, generalmente se recomienda no lanzar y capturar excepciones, sino usar métodos de validación. En .NET BCL, esta sería la diferencia entre, por ejemplo, int.Parse(produce una excepción en datos no válidos) y int.TryParse(devuelve falsedatos no válidos). Estoy diseñando el mío Foo.TryParse(string s, out Foo result) …

9 c#  .net  api-design 

Me gusta esto: Campaign: type: object properties: id: type: string description: "A GUID identifier" referenceId: type: string description: "A consumers identifier they have used to map their own systems logic to this object." name: type: string description: "'Great Campaign 2017' as an example" Estoy preocupado por la referenciaId . El …

9 rest  api  domain-driven-design  api-design  single-responsibility 

Tome un punto final de la API HTTP que escupe el siguiente modelo de respuesta: { "type": "Dog", "name": "Jessi", ... } El typecampo se ha descrito en la documentación como uno de Dog, Cato Fish. ¿Agregar una nueva opción, por ejemplo Rat, se consideraría un cambio de API de …

9 rest  api  api-design  json 

Comprendo REST que permite modelar operaciones de servicio como representación de estado y transición de un estado a otro haciendo uso de HTTP. Siempre he entendido los recursos como representaciones del estado del lado del servicio hasta hace poco cuando leí este artículo de Jimmy Bogard, a quien conozco como …

9 rest  api  api-design