Documentando APIs en Spring: Swagger

Documentar nuestras APIs es fundamental para que nuestro servicio pueda ser utilizado de forma sencilla y rápida. Generalmente se documentan las operaciones disponibles con sus parámetros de entrada, y las posibles salidas. Documentar es una tarea compleja porque debemos hacerlo cada vez que modificamos el código. Por eso es imprescindible el uso de herramientas que reduzcan esta complejidad.

Una de las especificaciones más extendidas para la documentación es la conocida como OpenAPI, que permite describir nuestra documentación mediante JSON o YAML. Con OpenAPI podemos especificar endpoints disponibles, operaciones y sus parametros, métodos de autenticación y información de contacto.

Swagger es una de las herramientas más utilizadas que implementan la especificación OpenAPI. Y SpringFox is la integración de Swagger para el framework Spring. Los componentes de Swagger son:
  • Swagger Editor – Un editor web en el que se pueden escribir especificaciones OpenAPI.
  • Swagger UI – Una aplicación web que genera una API interactiva.
  • Swagger Codegen – Una herramienta que genera librerías para OpenAPI.
Dependencias necesarias
Y para configurar Swagger necesitas crear un Docket Bean:
Toda la información necesaria está muy bien explicada en la documentación oficial

Comentarios

Entradas populares de este blog

Django REST framework

Envío de checkboxes o selector multiple por AJAX con jQuery

Django: Modelos