swagger离线文档操作手册

1. pom部分

<plugin>
    <groupId>io.github.swagger2markup</groupId>
    <artifactId>swagger2markup-maven-plugin</artifactId>
    <version>1.3.1</version>
    <configuration>
        <!-- api-docs访问url -->
        <swaggerInput>http://localhost:8999/v2/api-docs</swaggerInput>
        <!-- 生成为单个文档,输出路径 -->
        <outputFile>src/docs/asciidoc</outputFile>
        <config>
            <!-- ascii格式文档 -->
            <swagger2markup.markupLanguage>ASCIIDOC</swagger2markup.markupLanguage>
        </config>
    </configuration>
</plugin>
<plugin>
    <groupId>org.asciidoctor</groupId>
    <artifactId>asciidoctor-maven-plugin</artifactId>
    <version>1.5.6</version>
    <configuration>
        <!--目标文件-->
        <sourceDirectory>src/docs</sourceDirectory>
        <!--生成的html文件-->
        <outputDirectory>src/docs/html</outputDirectory>
        <headerFooter>true</headerFooter>
        <doctype>book</doctype>
        <backend>html</backend>
        <sourceHighlighter>coderay</sourceHighlighter>
        <attributes>
            <toc>left</toc>
            <!--自动打数字序号-->
            <sectnums>true</sectnums>
        </attributes>
    </configuration>
</plugin>

里面一些配置跟实际情况处理。

2. maven处理下载asciidoctor依赖失败的情况:

<mirror>
         <id>alimaven</id>
         <mirrorOf>central</mirrorOf>
         <name>aliyun maven</name>
         <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
</mirror>

3. 启动类开启

4. 点击插件

在这里插入图片描述
再点击:
在这里插入图片描述

5. 最终的效果

在这里插入图片描述

猜你喜欢

转载自blog.csdn.net/wangleisuiqiansuiyue/article/details/110437650
今日推荐