SpringBoot integra Swagger para facilitar las pruebas de back-end
Con Swagger, puedes probar la interfaz después de escribirla en el backend. El proceso de prueba es muy conveniente.
Swagger es un servicio web utilizado para generar, describir e invocar interfaces RESTful. En términos sencillos, Swagger es un servicio que muestra todas las interfaces del proyecto (que desea exponer) en la página y permite realizar llamadas y pruebas de interfaces.
Dirección del sitio web oficial de Swagger: https://swagger.io/
De la definición anterior de Swagger, podemos ver fácilmente que Swagger tiene las siguientes tres funciones importantes:
swagger2 es: http://localhost:8080/swagger-ui.html
swagger3 es: http://localhost:8080/swagger-ui/index.html
Preste atención a la observación: las anotaciones de swagger2 básicamente comienzan con API, para determinar si la anotación es una anotación de swagger2. Del mismo modo, swagger3 también tiene características similares.
swagger2 debe introducir las dependencias springfox-swagger2 y springfox-swagger-ui
El complemento lombok debe introducir las dependencias de lombok
De esta manera se configura swagger , el siguiente paso es cómo usarlo
Úselo en la clase de entidad
Úselo en la clase de entidad controlador
Dirección de acceso
http: //localhost:8080/swagger-ui.html
Icono
Después de ingresar el contenido, haga clic en probarlo para obtener el resultado
Usar swagger2 Es muy conveniente. Puede introducir dependencias y crear una clase de configuración para usarlo directamente. Usando cartero, debe crear manualmente cada enlace de acceso, lo cual es muy problemático.
La diferencia entre este y swagger2 es que
La anotación agregada al archivo de configuración es @EnableOpenApi y swagger2 es @EnableSwagger2. La dirección de acceso es http://localhost:8080/. swagger-ui/index.html y swagger2 son http://localhost:8080/swagger-ui.html. El archivo introducido por pom tiene solo un springfox-boot-starter, mientras que swagger2 tiene dos springfox-swagger2 springfox-swagger-ui.
entidad entidad Clase
No hay cambios en comparación con swagger2
controlador
aplicación.properties
Visita URL: http://localhost:8080/swagger -ui/index.html
Puedes ver que la interfaz de usuario se hace más grande y se ve mejor