Swagger para la documentación de la API

Swagger es un marco de software de código abierto que ayuda a los desarrolladores a diseñar, crear, documentar y consumir API RESTful. La documentación de Swagger es una representación de una API RESTful que se crea utilizando la especificación de Swagger. La especificación Swagger es un lenguaje de descripción de interfaz estándar para API REST. Permite a los desarrolladores describir la estructura de sus API y generar documentación en un formato legible por humanos. La documentación de Swagger generada incluye información sobre los extremos de la API, los parámetros de solicitud y respuesta y otros detalles relevantes. Puede ser utilizado por otros desarrolladores para comprender la funcionalidad de la API y realizar llamadas.

Características de arrogancia

La documentación de Swagger proporciona una serie de características, que incluyen:

1. Documentación interactiva: permite a los desarrolladores probar llamadas API y ver las respuestas en una interfaz de usuario basada en navegador.
2. Definición de API: proporciona una definición clara, concisa y fácil de entender para los humanos de lo que hace la API, sus puntos finales, parámetros y respuestas esperadas.
3. Generación de código: genera código de servidor y cliente en múltiples lenguajes de programación para ayudar a acelerar el proceso de desarrollo.
4. Validación: valida automáticamente las solicitudes y respuestas de la API para garantizar que cumplan con la especificación de la API.
5. Generación de documentación: genera automáticamente documentación de API en varios formatos, incluidos HTML, JSON y YAML.
6. Colaboración: admite la colaboración entre creadores, desarrolladores y partes interesadas de la API al proporcionar una ubicación centralizada para la documentación de la API.
7. Pruebas: proporciona un entorno para probar las llamadas a la API y garantizar que cumplan con el comportamiento deseado.
8. Control de versiones: admite el control de versiones de las API y permite a los usuarios ver y trabajar con varias versiones de una API.

La documentación de Swagger es compatible con varios lenguajes de programación, incluidos:

1. Java
2. Nodo.js
3. PHP
4. Pitón
5. Rubí
6. Ir
7. C#
8. Scala
9. Perl

Habilitar Swagger en el arranque de Spring

Para habilitar la documentación de Swagger en una aplicación Spring Boot, debe seguir estos pasos:

1. Agregue las dependencias springfox-swagger2 y springfox-swagger-ui al proyecto.
2. Habilite la compatibilidad con Swagger en su aplicación Spring Boot anotando su clase de configuración con @EnableSwagger2.
3. Cree un bean Docket para configurar las propiedades de Swagger, como la versión, el título y la descripción de la API.
4. Anote sus API RESTful con las anotaciones Swagger adecuadas, como @Api, @ApiOperation, @ApiParam, etc.
5. Ejecute la aplicación Spring Boot y acceda a la interfaz de usuario de Swagger en la URLhttp://localhost:port/swagger-ui.html, donde puerto es el puerto HTTP en el que se ejecuta su aplicación.

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

Configuración de Swagger 2 con una API REST de Spring | Baldung

Documentación de una API REST de Spring con OpenAPI 3.0 | Baldung