Saltar al contenido

Cómo definir un parámetro opcional en la ruta usando swagger

Si te encuentras con algún detalle que no entiendes puedes comentarlo y te ayudaremos lo más rápido posible.

Solución:

Dado que el parámetro de ruta debe ser requerido de acuerdo con el API abierta/Swagger especificación, puede considerar agregar 2 puntos finales separados con las siguientes rutas:

  • /get/param1/param2cuando se proporciona param2
  • /get/param1/cuando no se proporciona param2

Es probable que explote porque no puede tener un parámetro uri base opcional, solo consulta string valores (en el caso de una url).

Por ejemplo:

  • OBTENER /productos/id/precio?foo=bar
  • ** Si foo es opcional, su parámetro IN debe ser “consulta” y no “ruta”
  • ** Si id es opcional, algo anda mal. id no puede ser opcional porque está contenido dentro del uri base.

Esto debería funcionar:


"in":"query",
"required":false

Esto no debería funcionar


"in":"path",
"required":false

cambie su propiedad “in” para que sea “consulta” en lugar de “ruta” y debería funcionar.

Su YAML falla porque, como se indica en la especificación:

Determina si este parámetro es obligatorio. Si el parámetro está en “ruta”, esta propiedad es obligatoria y su valor DEBE ser true.

Fuente: http://swagger.io/specification/#parameterObject (Buscar en campos fijos mesa)

Te mostramos comentarios y puntuaciones

Puedes añadir valor a nuestra información participando con tu veteranía en las aclaraciones.

¡Haz clic para puntuar esta entrada!
(Votos: 0 Promedio: 0)



Utiliza Nuestro Buscador

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *