Prefacio
Creo que tanto los programadores front-end como los back-end no están familiarizados con Swagger. Deberían haber oído hablar de Swagger si no lo han usado antes.
Swagger es un marco estandarizado y completo para generar, describir, invocar y visualizar servicios Web de estilo RESTful.
Después de una configuración simple, se puede generar un documento API claro.
Pero no sé si ha encontrado que la interfaz de usuario nativa de Swagger no parece admitir el funcionamiento del encabezado de la solicitud. Encontré ese problema cuando integré JWT antes. La solución en ese momento era establecer parámetros globales. Pero para mí, tomó algún tiempo aprender, pero este método solo se puede aplicar a encabezados de solicitud específicos, y el acoplamiento es muy alto. Si se necesitan otros parámetros, el código debe modificarse.
Aquí hay tres tipos de interfaz de usuario mejorada de Swagger
Uno, swagger-mg-ui
Introducción
Dirección de código abierto : https://gitee.com/zyplayer/swagger-mg-ui
swagger-mg-ui es una implementación frontal de swagger. Es fácil de usar, rápida en resolución y diseñada para ser deliberada. Admite la visualización simultánea de varios proyectos, una variedad de soluciones de visualización de catálogos de documentos y múltiples configuraciones personalizadas para satisfacer diversos hábitos de uso.
utilizar
Muy simple, solo agregue la siguiente dependencia de maven
<!-- https://mvnrepository.com/artifact/com.zyplayer/swagger-mg-ui -->
<dependency>
<groupId>com.zyplayer</groupId>
<artifactId>swagger-mg-ui</artifactId>
<version>1.0.6</version>
</dependency>
Visita después del inicio: http: // localhost: 8080 / document.html view
Caracteristicas
La interfaz de usuario admite una variedad de métodos de visualización del menú de árbol, pero me siento un poco mal porque los colores de todas las solicitudes son iguales, no tan claros como la interfaz de usuario original.
swagger-mg-ui admite la configuración de encabezados de solicitud, y hace que la solicitud sea persistente, registrará las solicitudes que ha probado, pero es un poco malo que almacene los datos en LocalStorage, es decir, si hay más pruebas , Ocupará algo de espacio.
Dos, swagger-ui-layer
Introducción
Dirección de código abierto : https://gitee.com/zyplayer/swagger-mg-ui
swagger-ui-layer es una implementación de interfaz de usuario de front-end basada en swagger. Reemplaza el swagger-ui predeterminado y hace que los documentos generados sean más amigables y hermosos.
swagger-ui-layer también puede decir por el nombre que ui y layui están algo relacionados. swagger-ui-layer es de hecho estilo layui, pero desafortunadamente este proyecto ha sido descontinuado y no es compatible con los últimos SpringBoot y Swagger. Ríndete temporalmente (solo inventa el número)
Captura de pantalla de la demostración del sitio web oficial
Tres, cuchillo4j
Introducción
Dirección de código abierto : https://gitee.com/xiaoym/knife4j
Dirección del sitio web oficial : https://doc.xiaominfo.com/
Knife4j es una solución mejorada para el framework Java MVC para integrar Swagger para generar documentos Api. Su predecesor es swagger-bootstrap-ui, llamado kni4j con la esperanza de que pueda ser tan pequeño como una daga, liviano y poderoso.
El predecesor de knife4j es swagger-bootstrap-ui. Para adaptarse al desarrollo de la arquitectura de microservicio, dado que el swagger-bootstrap-ui original adopta el código de Java de back-end + el método de empaquetado híbrido de interfaz de usuario de front-end, está muy hinchado bajo la arquitectura de microservicio, por lo que El proyecto cambió oficialmente su nombre a knife4j
Este debería ser el mejor proyecto de mejora de Swagger. Todavía se está manteniendo y es un proyecto GVP de Code Cloud. También vale la pena mencionar que este proyecto admite el uso bajo la arquitectura de microservicio SpringCloud y no es necesario introducir recursos de interfaz de usuario en cada microservicio. Me temo que no podré presentar la gama completa de funciones, por lo que debe explorarlo usted mismo.
utilizar
Es muy sencillo.
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-ui</artifactId>
<version>${lastVersion}</version>
</dependency>
Luego inicie la visita del proyecto: http: // localhost: 8080 / doc.html view
Caracteristicas
La función de esta interfaz de usuario es como PostMan integrado en el proyecto, y una página de pestañas está cuidadosamente diseñada para admitir la configuración de los parámetros de solicitud de encabezado de solicitud y la compatibilidad con la lectura sin conexión de documentos exportados.
También hay una característica muy útil que admite la configuración de parámetros globales. Recuerda lo que dije sobre la depuración de JWT. Este proyecto parece haber nacido para depurar JWT. Puedes probar todas las interfaces agregando un encabezado de solicitud global. , Muy conveniente
Lo he usado