如何详细解析Spring Boot整合Smart-doc自动构建接口文档?

2026-05-25 20:011阅读0评论SEO教程
  • 内容介绍
  • 文章标签
  • 相关推荐

本文共计1253个文字,预计阅读时间需要6分钟。

如何详细解析Spring Boot整合Smart-doc自动构建接口文档?

目录+前言+功能特性+1. 项目中创建+ /src/main/resources/smart-doc.json配置文件+2. 配置内容如下(指定文档的输出路径)+3. pom.xml下添加配置+4. 运行插件+5. 找到存放路径浏览器打开+6. 测试结果+前言

目录
  • 前言
  • 功能特性
    • 1 项目中创建 /src/main/resources/smart-doc.json配置文件
    • 2 配置内容如下(指定文档的输出路径)
    • 3 pom.xml下添加配置
    • 4 运行插件
    • 5 找到存放路径浏览器打开
    • 6 测试结果

前言

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。

smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污染,那请拥抱 smart-doc 吧!

功能特性

  • 支持接口 debug。
  • 零注解、零学习成本、只需要写标准 java 注释。
阅读全文

本文共计1253个文字,预计阅读时间需要6分钟。

如何详细解析Spring Boot整合Smart-doc自动构建接口文档?

目录+前言+功能特性+1. 项目中创建+ /src/main/resources/smart-doc.json配置文件+2. 配置内容如下(指定文档的输出路径)+3. pom.xml下添加配置+4. 运行插件+5. 找到存放路径浏览器打开+6. 测试结果+前言

目录
  • 前言
  • 功能特性
    • 1 项目中创建 /src/main/resources/smart-doc.json配置文件
    • 2 配置内容如下(指定文档的输出路径)
    • 3 pom.xml下添加配置
    • 4 运行插件
    • 5 找到存放路径浏览器打开
    • 6 测试结果

前言

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。

smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污染,那请拥抱 smart-doc 吧!

功能特性

  • 支持接口 debug。
  • 零注解、零学习成本、只需要写标准 java 注释。
阅读全文