springboot将接口内容快速生成接口文档导出,swagger将api文档以表格文档导出

我们开发工作中,经常需要面对写文档的事情.后端写给前端,甲方给乙方提供技术接口文档.有时候会觉得挺麻烦.

虽然swagger已经为我们提供了不少便利,但通常对外提供文档时,人们希望接口参数等内容,是以表单形式展现的,比如:

 

 于是我找到了将swagger转为类似这种表格参数展示的Swagger2Markup.它的使用也比较简单方便.基本可以满足需要.

下面是我对这个Swagger2Markup使用的代码地址:https://github.com/OceanBBBBbb/swaggerdoc

可以直接把这个在内网部署一套,而不必为所有项目添加Swagger2Markup..因为只要输入swagger-doc的地址,就可以导出这个项目的API文档了.

 

根据swagger访问路径,导出完整规范的接口文档

说明

如果只是需要嵌入已存在的swagger项目， 加上maven配置，加入test里的Swagger2Doc.java修改url就可以了。
实现转换使用的是Swagger2Markup

引入Swagger2Markup

    io.github.swagger2markup
    swagger2markup
    1.3.3

　　

这时候执行测试类内容时，通常会报一个错。如相关jar包不存，如

NoClassDefFoundError: ch/netzwerg/paleo/ColumnIds$StringColumnId

　　

等等，官方给的解释一般是，加上：

    
        
            false
        
        jcenter-releases
        jcenter
        http://jcenter.bintray.com
    

　　

如果没解决，我这就是这个情况，可以把上面的repositories内容改为：

    
        spring-libs-milestone
        https://repo.spring.io/libs-milestone
        
            false
        
    
    


    
        spring-plugins-release
        https://repo.spring.io/plugins-release
        
            false
        
    

　　

编写测试类

可以直接用这里的测试目录里的Swagger2Doc.java，还可以根据Swagger2Markup 的说明做一些个性化的修改。

如何使用swaggerdoc

（后面准备在加上转word、pdf等格式，加上docker方便快速部署）
启动swaggerdoc后，访问http://localhost:8080

正常将看到如图页面，输入可访问的swagger-api文档地址，注意是这个一般后缀为api-docs的可以访问到 文档json内容的地址。而不是swagger-ui.html这个。如

然后选择文档类型：
* Markdown: 就是熟悉的README.MD格式，拿到后，导入到Markdown编辑器即可。
* Confluence: wiki格式，在Confluence中使用时，导入为wiki格式。
* AsciiDocs: 这个我也不知道在哪用。

可以看一下Markdown的效果：

和

Confluence的效果（截图内容都是冰山一角）