smart-doc的接入

最新推荐文章于 2025-10-24 03:23:05 发布

原创最新推荐文章于 2025-10-24 03:23:05 发布 · 810 阅读

9 ·

CC 4.0 BY-SA版权

文章标签：

#java

springboot 专栏收录该内容

22 篇文章

订阅专栏

这个文档工具在目前我所经手的项目中广泛之使用，如图，需要的功能基本都有了🥰

smart-doc 有啥优点

由于仅有 plugin 及一个json配置,无任何 ApiModelProperty 、 ApiModel 及 Schema 侵入性注解代码
可以生成诸如 html（单文件需要先走adoc后转html）、openapi、postman、jmeter、word 等主流且前端用也可后端测试用之文档
文档定义更简单，仅需有限的注解及 Jakarta 相关注解配合使用即可, 其他扩展文档见 smart-doc

如何使用

在项目中添加 plugin 配置，这里仅以 maven 项目实例

<!--文档工具-->
<plugin>
  <groupId>com.ly.smart-doc</groupId>
  <artifactId>smart-doc-maven-plugin</artifactId>
  <version>3.1.0</version>
  <configuration>
    <!--配置文件位置-->
    <configFile>./src/main/resources/smart-doc.json</configFile>
    <!--<projectName>${application.name}</projectName>-->
    <!--<configFile>${application.name}</configFile>-->
  </configuration>
  <!--项目编译时执行生成html不需要可以去掉executions标签-->
  <executions>
    <execution>
      <!--打包的时候构建文档(install package)-->
      <phase>package</phase>
      <goals>
        <!--adoc文档，后续用asciidoc生成html单文档-->
        <goal>adoc</goal>
        <!--构建文档类型 -->
        <!--api只构建html文档-->
        <!--<goal>html</goal>-->
        <!--统一接口只构建adoc文档-->
        <!--<goal>rpc-adoc</goal>-->
      </goals>
    </execution>
  </executions>
</plugin>
 
<!--文档工具:用于将smart-doc生成的adoc文件转换为html文档-->
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>1.5.8</version>
<configuration>
  <!--预构建文档目录-->
  <sourceDirectory>./adoc</sourceDirectory>
  <!--文档输出目录-->
  <outputDirectory>./doc</outputDirectory>
  <headerFooter>true</headerFooter>
  <doctype>book</doctype>
  <backend>html</backend>
  <sourceHighlighter>coderay</sourceHighlighter>
  <attributes>
    <!--菜单栏在左边-->
    <toc>left</toc>
    <!--多标题排列-->
    <toclevels>3</toclevels>
    <!--自动打数字序号-->
    <sectnums>true</sectnums>
  </attributes>
</configuration>
<executions>
  <execution>
    <phase>package</phase>
    <goals>
      <goal>process-asciidoc</goal>
    </goals>
  </execution>
</executions>
</plugin>
<!-- 文档工具结束-->

plugin在多模块项目中表现为:

在项目中定义 smart-doc.json 配置文件,一般在 resources 目录下

  {
    "outPath":"adoc",
    "allInOne":true,
    "allInOneDocFileName":"mee_admin-1.0.1",
    "projectName":"mee_admin",
    "createDebugPage":true,
    "revisionLogs":[
      {
        "version":"2025-06-26",
        "author":"shadow",
        "revisionTime":"2025-06-26 19:28:18",
        "status":"1.0.1",
        "remarks":"接口及文档优化"
      }
    ]
  }

这个 smart-doc.json 在 plugin 中有引用，相对地址不要弄错了

在 idea 的 maven 面板依次操作=>生成单html文档文件

使用技巧及注意事项

字段的注释不可以含有竖杠(eg: | ), 可能造成文档出现偏移

// eg: 
/**
* 菜单类型(1.目录 | 2.菜单 | 3.按钮）
*/
private Integer type;

入口注释字段 @param 的值不可为空, 可导致无法生成文档

   // eg:
    /**
     * 系统::文件管理::删除
     * @param status 状态
     * @param
     */
    @RequiresPermissions("sys:sys_file:delete")
    @DeleteMapping("/delete")
    @ResponseBody
    public MeeResult<Integer> deleteById(@RequestParam(required = true) String id,@RequestParam(required = true) String status){
      return sysFileService.deleteById(id,status);
    }

smart-doc 强烈推荐使用 3.1.x 以上的版本,若使用 3.1.x 以下版本多个 @RequestHeader 时生成的文档会出现行偏移

  // eg:
  @RequiresPermissions("sys:sys_file:delete")
  @DeleteMapping("/delete")
  @ResponseBody
  public MeeResult<Integer> deleteById(@RequestHeader String aa ,@RequestHeader String status){
      return sysFileService.deleteById(id,status);
  }