SpringBoot2 genera documentos API sin conexión basados en Swagger2
Github: /ChaselX/springboot-swagger2-offline-api-doc
Gitee: /chasel96/springboot-swagger2-offline-api-doc
Personal Siento que la configuración de la versión anterior es mucho más simple, pero la configuración de la nueva versión es aún mucho más complicada según la configuración de demostración oficial
Después de configurarlo en el proyecto Springboot, se generará en el directorio especificado a través de pruebas unitarias cuando el proyecto está empaquetado en documentos sin conexión, oficialmente llamado staticdocs
Todas las dependencias citadas en esta publicación de blog deben introducirse en Spring Rest Docs y sin conexión. Los documentos dependen de springfox-staticdocs, porque debe probarse en la prueba unitaria. Al generar documentos, debe agregar spring-boot-starter-test relacionado con la prueba.
El complemento asciidoctor-maven-plugin convertirá archivos en formato Asciidoc al formato HTML5 para su salida.
Esta clase contiene dos métodos, TestApi() se usa para generar ejemplos y test() se usa para generar documentación Asciidoc. Spring-restdocs-mockmvc se utiliza para generar ejemplos. Cada API debe probarse unitariamente para generar los fragmentos de documentos correspondientes. Los resultados generados se muestran en la figura:
Swagger2MarkupConverter se utiliza para generar documentos Asciidoc completos. El primer paso es obtener la versión en línea del documento y guardarlo en el archivo swagger.json. El segundo paso es integrar swagger.json con los fragmentos de ejemplo anteriores y guardarlo como un documento completo en formato Asciidoc. El resultado generado es como se muestra en la figura:
Defina información relacionada con el documento a través de la clase de configuración
Ruta: nombre del proyecto/docs/asciidoc/index.adoc
Utilice la configuración anterior El complemento maven solo necesita realizar el empaquetado para generar los documentos correspondientes, como se muestra en la figura:
Se deben introducir todas las dependencias citadas en esta publicación de blog, Spring Rest Docs Depende de spring-restdocs-mockmvc, y los documentos fuera de línea dependen de springfox-staticdocs. Debido a que la documentación debe generarse durante las pruebas unitarias, es necesario agregar spring-boot-starter-test relacionado con la prueba.
El complemento asciidoctor-maven-plugin convertirá archivos en formato Asciidoc al formato HTML5 para su salida.
Esta clase contiene dos métodos, TestApi() se usa para generar ejemplos y createSpringfoxSwaggerJson() se usa para generar documentos Asciidoc.
Spring-restdocs-mockmvc se utiliza para generar ejemplos. Cada API debe probarse unitariamente para generar los fragmentos de documentos correspondientes. Los resultados generados se muestran en la figura:
Swagger2MarkupConverter se utiliza para generar el documento Asciidoc completo. El primer paso es obtener la versión en línea del documento y guardarlo en el archivo swagger.json. El segundo paso es integrar swagger.json con los fragmentos de ejemplo anteriores y guardarlo como un documento completo en formato Asciidoc. El resultado generado es como se muestra en la figura:
Defina información relacionada con el documento a través de la clase de configuración
Cree un archivo de configuración llamado logback.xml en el directorio de recursos y use LogstashEncoder como codificador de registro predeterminado
Ruta: nombre del proyecto src/docs/asciidoc/index.adoc
Usando el complemento maven configurado anteriormente, solo necesita realizar el empaquetado para generar el documento correspondiente, como se muestra en la figura: