Versiones comparadas

Clave

  • Se ha añadido esta línea.
  • Se ha eliminado esta línea.
  • El formato se ha cambiado.

...

  • summary => Título, resumen descriptivo del endpoint.
  • description => Descripción larga del endpoint.
  • tags => Listado de tags para agrupar endpoints en la documentación. Se puede recomienda agrupar por "Private" o "Public", por recurso, por versiones...al gusto del desarrollador pero manteniendo el mismo criterio en la aplicación.los endpoints por el recurso expuesto.  
  • security => Añadir si el servicio es privado.
  • responses => Listado de códigos de respuesta devueltos por el endpoint, agrupados en notaciones ApiResponse. 
                         Rellenar, según el caso:
        • responseCode => código de respuesta http
        • description => descripción de la casuística cuando se devuelve el código de respuesta
        • content => clase devuelta cuando sucede la respuesta, por ejemplo, un DTO devuelto. (No incluir en caso de error o desconocimiento, es opcional).

...