swagger2生成离线Markdown文档

  1. 添加swagger2Markup插件 在模块pom文件中添加相应的插件 注意:修改swaggerInput参数内容
<plugin>
                <groupId>io.github.swagger2markup</groupId>
                <artifactId>swagger2markup-maven-plugin</artifactId>
                <version>1.3.3</version>
                <configuration>
                    <swaggerInput>http://10.0.50.236:8080/file/v2/api-docs</swaggerInput>
                    <!--                    <outputDir>src/docs/asciidoc/generated</outputDir>-->
                    <!-- 生成markdown格式 -->
                    <outputFile>src/docs/markdown/generated/all</outputFile>
                    <config>
                        <!-- 生成markdown格式 -->
                        <swagger2markup.markupLanguage>MARKDOWN</swagger2markup.markupLanguage>
                        <swagger2markup.outputLanguage>ZH</swagger2markup.outputLanguage>
                        <swagger2markup.generatedExamplesEnabled>true</swagger2markup.generatedExamplesEnabled>
                        <swagger2markup.inlineSchemaEnabled>false</swagger2markup.inlineSchemaEnabled>
                        <swagger2markup.pathsGroupedBy>TAGS</swagger2markup.pathsGroupedBy>
                    </config>
                </configuration>
            </plugin>

swaggerInput参数修改内容如下:

  1. 生成文档

运行项目,执行maven窗口对应项目下swagger2Markup插件

  1. 结果查看
经验分享 程序员 微信小程序 职场和发展