apiary.io - mock - ¿Cómo puedo tener múltiples respuestas desde un único punto final con diferentes parámetros?

apiary soap

Question

Estamos mirando el uso de la API Blueprint. Hay casos en los que nos gustaría que una solicitud devuelva una respuesta adecuada y otra solicitud que devuelva una respuesta de ''error'', como una 400 bad request para que otros desarrolladores puedan trabajar contra la API simulada en apiary.io con ambos tipos de respuestas y Manejarlo en sus aplicaciones.

He creado un ejemplo completamente arbitrario a continuación,

## Thing [/thing/{id}]
Gets a thing but the thing id must be a prime number!
+ Parameters
+ id (string) ... ID of the thing, a prime number!
+ Model (application/json)
The thing itself.
+ Body
{
"description": "It is green"
}
### Retrieve a Single Gist [GET]
+ Response 200
[Gist][]

Ahora de alguna manera me gustaría agregar una respuesta para /thing/40

+ Response 400
{ "error" : "Invalid request" }

Pero no estoy seguro de cómo haría esto con la API Blueprint. Esto se pudo lograr bajo el estilo ''antiguo'' en apiary.io, pero nos gustaría pasar a la nueva sintaxis

Answer 1

Para documentar múltiples respuestas, simplemente agréguelo después de la Response 200 manera:

## Thing [/thing/{id}]
Gets a thing but the thing id must be a prime number!
+ Parameters
+ id (string) ... ID of the thing, a prime number!
+ Model (application/json)
The thing itself.
+ Body
{
"description": "It is green"
}
### Retrieve a Single Gist [GET]
+ Response 200
[Thing][]
+ Response 400 (application/json)
{ "error" : "Invalid request" }

Tenga en cuenta que actualmente no hay una sintaxis dedicada para discutir las condiciones (cuando se devuelve esta respuesta). Puedes discutirlo como quieras, por ejemplo:

+ Response 400 (application/json)
This response is returned when no `Thing` for given `id` exists.
+ Body

Si está utilizando el simulador de Colmenar, tenga en cuenta que la primera respuesta que se enumera se devuelve de forma predeterminada, a menos que usted indique lo contrario utilizando el encabezado HTTP preferido .

Answer 2

Puede usar las plantillas y especificar un caso de uso específico después de una respuesta genérica para su recurso, vea el ejemplo:

Reserva [/ reserva / {reservation_key}]

Un objeto de reserva tiene los siguientes atributos:

• número de habitación
• reserved_at - Una fecha ISO8601 cuando se publicó la pregunta.

• booker_details - Un objeto Booker.

• Parámetros

  • reservation_key (requerido, texto, 1 ) ... Clave de reserva ash

Ver un detalle de reserva [GET]

• Respuesta 200 (aplicación / json)

  {
  "room_number": 55,
  "reserved_at": "2014-11-11T08:40:51.620Z",
  "booker_details":
  {
  "name": "Jon",
  "last_name": "Doe",
  }
  }

Reserva [/ reserva / notarealreservation123]

Usando una reserva no existente (los pls usan notarealreservation123 en el falso) devoluciones no encontradas