spring boot 文档生成

重生之我是一名程序员

于 2023-11-19 21:21:58 发布

阅读量122

点赞数

分类专栏： spring boot 文章标签： spring boot

原文链接：https://editor.csdn.net/md?not_checkout=1&spm=1001.2101.3001.4503&articleId=134495839

版权

spring boot 专栏收录该内容

81 篇文章 1 订阅

订阅专栏

本文介绍了如何在SpringBoot项目中利用smart-docMaven插件生成API文档，包括引入依赖、配置smart-doc.json文件以及自动生成HTML文档的过程，特别提到了其对原生注解的支持和自动填充参数响应功能。

摘要由CSDN通过智能技术生成

spring boot 文档生成

使用 smart-doc 来生成文档，无入侵，支持原生注解

引入依赖

 <plugin>
 <groupId>com.github.shalousun</groupId>
    <artifactId>smart-doc-maven-plugin</artifactId>
    <version>2.6.2</version>
    <!--配置文件位置-->
    <configuration>
        <configFile>src/main/resources/smart-doc.json</configFile>
        <projectName>测试接口文档</projectName>
        <!--项目编译时执行生成html 不需要可以去掉executions 标签 -->
        <includes>
            <include>com.x.z.*</include>
        </includes>
    </configuration>
    <executions>
        <execution>
            <phase>compile</phase>
            <goals>
                <goal>html</goal>
            </goals>
        </execution>
    </executions>
</plugin>

在 resources 目录下创建 smart-doc.json

{
  "outPath": "D:/tmp/doc",
  "createDebugPage": true,
  "allInOne": true,
  "coverOld": true,
  "projectName": "测试接口文档"
//  "packageFilters": "com.x.x.ShopController"
}