Springboot+Swagger生成在线文档、离线文档

生成在线文档(不细说,很多可用的教程)

  • 加好注解
    • 接口的注解
    • model的注解

生成离线文档

将Swagger2文档导出为HTML或markdown等格式离线阅读
https://www.cnblogs.com/zimug/p/11933051.html

遇到的问题:java.lang.NoClassDefFoundError: nl/jworks/markdown_to_asciidoc/Converter
解决方式:换成阿里的镜像资源
https://blog.csdn.net/qq_30059235/article/details/106690848?utm_medium=distribute.pc_relevant.none-task-blog-baidujs-1

关键步骤:

  • 先切换镜像地址
  • 重要文件:配置文件SwaggerConfig
  • 重要文件:Swagger2OfflineApplicationTests
    • 先执行方法generateAsciiDocs 生成.adoc文件
    • 在执行方法 generateMarkdownDocsToFile生成.md文件
  • pom文件增加插件,在右侧双击插件生成html接口文档

你可能感兴趣的:(Springboot+Swagger生成在线文档、离线文档)