美文网首页
Springboot+Swagger生成在线文档、离线文档

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

作者: lbcBoy | 来源:发表于2020-06-23 23:08 被阅读0次

生成在线文档（不细说，很多可用的教程）

  • 加好注解
    • 接口的注解
    • 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生成在线文档、离线文档

      本文链接：https://www.haomeiwen.com/subject/phbkfktx.html

      延伸阅读

      深度阅读

      • 您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！

      栏目导航

      热点阅读

      关于我们|服务条款|联系我们|Springboot+Swagger生成在线文档、离线文档|投稿指南|网站地图|RSS订阅|排版工具|手机版

      提供经典美文摘抄,优美散文欣赏,现代诗歌精选,短篇小说,心情随笔,表白情书范文,故事会在线阅读欣赏

      Copyright © 2014-2023 Haomeiwen.com All Rights Reserved. 好美文阅读网 版权所有

      备案信息：桂公网安备 45052102000051号 · 桂ICP备13007215号-3

      本站所收录作品、热点评论等信息部分来源互联网，目的只是为了系统归纳学习和传递资讯

      所有作品版权归原创作者所有，与本站立场无关，如不慎侵犯了你的权益，请联系我们告知，我们将做删除处理！