我们开发工作中,经常需要面对写文档的事情.后端写给前端,甲方给乙方提供技术接口文档.有时候会觉得挺麻烦.
虽然swagger已经为我们提供了不少便利,但通常对外提供文档时,人们希望接口参数等内容,是以表单形式展现的,比如:
于是我找到了将swagger转为类似这种表格参数展示的Swagger2Markup.它的使用也比较简单方便.基本可以满足需要.
下面是我对这个Swagger2Markup使用的代码地址:https://github.com/OceanBBBBbb/swaggerdoc
可以直接把这个在内网部署一套,而不必为所有项目添加Swagger2Markup..因为只要输入swagger-doc的地址,就可以导出这个项目的API文档了.
根据swagger访问路径,导出完整规范的接口文档
引入Swagger2Markup
这时候执行测试类内容时，通常会报一个错。如相关jar包不存，如
如果没解决，我这就是这个情况，可以把上面的repositories内容改为：
编写测试类
可以直接用这里的测试目录里的Swagger2Doc.java，还可以根据Swagger2Markup 的说明做一些个性化的修改。
正常将看到如图页面，输入可访问的swagger-api文档地址，注意是这个一般后缀为api-docs的可以访问到 文档json内容的地址。而不是swagger-ui.html这个。如
可以看一下Markdown的效果：
和
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请联系我们，一经查实，本站将立刻删除。
如需转载请保留出处：https://51itzy.com/kjqy/176590.html