Knife4j 2.0.2 lanzado oficialmente, herramienta de documentación de la interfaz que permite Swagger

Knife4jAnteriormente conocido como swagger-bootstrap-uies una herramienta de documentación de la interfaz que permite a Swagger

Documentación : https://doc.xiaominfo.com

Efecto (versión antigua) : http://swagger-bootstrap-ui.xiaominfo.com/doc.html

Efecto (2.X versión) : http://knife4j.xiaominfo.com/doc.html

Gitee : https://gitee.com/xiaoym/knife4j

GitHub : https://github.com/xiaoymin/swagger-bootstrap-ui

Ejemplo : https://gitee.com/xiaoym/swagger-bootstrap-ui-demo

Características y Optimización

knife4j

1, el nuevo knife4j-dependenciesmódulo, la gestión knife4j referencias relacionadas Maven, Maven puede ser introducido en una lista de materiales de maneraKnife4j

2, la página oficial del documento actualizado de forma simultánea.

3, la resolución swagger-annotationsde conflictos de versión causadas gitee # I17G31 , GitHub # 191

knife4j-resorte-ui

1, la solicitud de reparación no se envía después de la pestaña de parámetros de traspaso no se visualiza de nuevo los datos de respuesta tema, y así sucesivamente excepción de depuración PR 13 es @gitee , gitee # I17FFX , GitHub # 196 , GitHub # 187

2, optimizado cuadro de depuración comprobado todas las preguntas, cuando se cancela toda la elección, sólo seleccionar este parámetro cuando el cambio de los parámetros de entrada, en sustitución del original seleccionado por defecto todos los parámetros gitee # I19V6D

3, para el tipo de formulario de solicitud de línea de comando de configuración de enrollamiento Formulario en la ausencia de un valor de entrada es nulo, y una cadena nula modificado gitee # I18IBZ

4, optimizar la función de ajuste del parámetro global, es demasiado largo para los datos de parámetros no se ajusta el problema, y la necesidad de ser eliminada cuando la necesidad de modificar los parámetros de la experiencia interactiva, los desarrolladores pueden fácilmente modificar valores de parámetros y datos de parámetros Después de agregar el tipo de parámetro gitee # I17OV1 , gitee # I19GJK , gitee # I1A9V1 , gitee # I18HMJ , GitHub # 176

5, en el caso en que el parámetro de la petición no se da valores predeterminados ejemplo, la propiedad de la caja de entrada de texto PLACEHOLDER descripción de texto de visualización del campo gitee # I17RKI

6, aumentar el parámetro cuestiones de propiedad reparación ignorado no es efectiva de gitee # PR-16 , gitee # I136KU , gitee # I187VN , gitee # I16A71

7, los parámetros de ajuste para aumentar la ayuda de la caja enumeración de servicios de fondo, cambiar el cuadro de entrada-desplegables cuadro de selección gitee # I18MHO

8, un servicio de worker.js reportaron 404 problemas, añadir este archivo para crear paquetes gitee # I17D0Y , GitHub # 185

9, conseguir un proceso de solicitud de parámetro de codificación existen caracteres especiales que no están conduciendo a errores 400 gitee # I19C8Y

10, después de que el extremo posterior de la nueva interfaz o una interfaz para la edición, la bandera de actualización de la pantalla en la interfaz de la interfaz de usuario, habrá un logotipo azul en el menú gitee # I1AQFW , como se muestra a continuación:

11, la anotación back-end mejorada @ApiOperationSupport(author = "[email protected]")apoyo cada interfaz proporciona a los desarrolladores con la presentación de la final de la siguiente figura:

12, la depuración botón Enviar aumenta loadingel rendimiento y mejora el efecto de interacción para la siguiente respuesta más largo de la interfaz

13, para el parámetro Autorizar la barra de menú para guardar los parámetros son el ahorro global cuando otra agrupación lógica y luego interfaz de depuración, no es necesario guardar un nuevo valor gitee # I16Z10

14, algunos casos de reparación de campo de respuesta no se muestra en el caso de las descripciones de los campos editor de as-editor de la columna derecha gitee # I17F5Y

15, el complemento perfecto cuadro de búsqueda de la interfaz de búsqueda difusa dirección de solicitud de API barra gitee # I19EN0 , gitee # I1B0Q9

16, la depuración de la línea de datos de respuesta es demasiado larga, el problema no puede envolver gitee # I17F1J

17, la interfaz actual sin parámetros, la interfaz de añadir parámetros globales de errores ineficaces

Si backend es Java + Primavera pila de tecnología, mientras que el uso de springfox, como un cambio de piel Swagger Ui, puede ser introducido por el pom.xml directamente de la siguiente manera:

< Dependencia > 
  < groupId > com.github.xiaoymin </ groupId > 
  < artifactId > knife4j-resorte-ui </ artifactId > 
  < versión > 2.0.2 </ versión > 
</ dependencia >

Knife4j-primavera

Primavera Boot usando tecnología de pila se pueden incorporar rápidamente por arranque de referencia se usa, nota que el arrancador conjunto que comprende Ui como sigue:

< Dependencia > 
  < groupId > com.github.xiaoymin </ groupId > 
  < artifactId > knife4j-primavera-arranque-motor de arranque </ artifactId > 
  < versión > 2.0.2 </ version > 
</ dependencia >

Si este es el caso de las micro-servicios, micro-servicios efectivamente hacen referencias no necesita el paquete frasco Ui, sólo es necesario hacer referencia al paquete frasco depende Ui en la entrada, por lo que en el caso de las micro-servicios, para mejorar el uso de la propiedad sólo es necesario hacer referencia a la versión micro-servicio de la dependencia del motor de arranque, como sigue:

< Dependencia > 
    < groupId > com.github.xiaoymin </ groupId > 
    < artifactId > knife4j-micro-resorte-arranque-motor de arranque </ artifactId > 
    < versión > 2.0.2 </ versión > 
</ dependencia >

característica

• Sobre la base de los documentos Vue + Diseño de generación Ant, más potentes, capacidades de documentación interfaz limpia, y la capacidad de las interfaces de depuración

• Sobre el diseño, basado en componentes multi-documento estilo opinión aquí

• El soporte en línea exportación de una variedad de formatos HTML, Markdown, Word, PDF y otros documentos fuera de línea

• Interfaz de clasificación, agrupación y clasificación de las capacidades de apoyo a las interfaces

• soporte de interfaz de la función global de búsqueda en línea

• Swagger recursos para proporcionar estrategia de protección de la seguridad del documento de protección contra

• Parámetros de interfaz de soporte de depuración ilimitada, los desarrolladores de depuración es muy flexible y agregar de forma dinámica, el parámetro de borrado

• Información global caché de depuración, todavía existe actualizar la página, permitiendo a los desarrolladores fácilmente depuración

• En una mesa componente arbóreo más humano que representa funciones Modelos Swagger

• Puede mostrar varios documentos en una de varias fichas manera documentación de la interfaz

• Solicitud parámetro de tipo de campo de la solicitud, si el código de colores requeridos

• Las estadísticas en bruto el número de diferentes tipos de interfaces de página de inicio

• Los parámetros globales personalizados Soporte de funciones, incluyendo la cabecera página de inicio y ambos tipos de consulta

• apoyo JSR-303 anotaciones Las anotaciones

• Más función de personalización

interfaz

Documentación de la interfaz de visualización de interfaz de la siguiente manera:

interfaz de puesta en marcha de la siguiente manera:

Los modelos cuentan con Swagger

exportación de soporte en línea función de rebajas, HTML, tabla de reducción del precio que la versión original mediante la reducción que se muestra como una estructura de árbol, haga clic en Vista previa para exportar efecto fuera de línea en HTML , el efecto es el siguiente:

Exportado por un efecto de rebajas software de terceros PDF como se muestra a continuación:

Mientras que proporciona fuera de línea HTML de exportación función, estilo y función de interfaz HTML en línea casi no hay diferencia, hermoso, elegante, simple, haga clic en la vista previa en línea ,

a continuación el efecto de interfaz:

Star & Edición

Gracias por el apoyo de amigos, ir https://gitee.com/xiaoym/knife4j punta de una estrella que ~ ~ :)