接口文档生成工具smart-doc

末蓝、 2022-09-10 12:13 315阅读 0赞

# 官网 #

https://gitee.com/smart-doc-team/smart-doc

# 简介 #

smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念，完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。

你只需要按照java-doc标准编写注释， smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman、Collection2.0+、OpenAPI 3.0+的文档。

## 特点 ##

零注解、零学习成本、只需要写标准JAVA注释。  
基于源代码接口定义自动推导，强大的返回结构推导。  
支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller书写方式)、Feign。  
支持Callable、Future、CompletableFuture等异步接口返回的推导。  
支持JavaBean上的JSR303参数校验规范，包括分组验证。  
对JSON请求参数的接口能够自动生成模拟JSON参数。  
对一些常用字段定义能够生成有效的模拟值。  
支持生成JSON返回值示例。  
支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。  
支持生成多种格式文档：Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。Up- 开放文档数据，可自由实现接入文档管理系统。  
支持导出错误码和定义在代码中的各种字典码到接口文档。  
支持Maven、Gradle插件式轻松集成。  
支持Apache Dubbo RPC接口文档生成。  
debug接口调试html5页面完全支持文件上传，下载(@download tag标记下载方法)测试。  
Smart-doc 从 2.0.0 后几乎实现了 swagger ui 的功能，并且比 swagger ui 更简洁大方，也更符合国内开发者的诉求。

当然 smart-doc 本身是只支持扫描代码生成 openapi 3.0 的文档的，也可以将生成的 openapi 3.0 文档导入到其他ui中渲染展示。另外，欢迎关注公众号Java笔记虾，后台回复“后端面试”，送你一份面试题宝典！

## 效果示例 ##

1.1 接口文档效果图  
图片  
输入图片说明  
图片  
请求参数示例  
图片  
响应参数示例  
1.2 html全局效果  
图片  
html文档

## 使用 ##

## 配置 ##

config.setCoverOld(true); //since 1.7.5 //设置项目名(非必须)，如果不设置会导致在使用一些自动添加标题序号的工具显示的序号不正常 config.setProjectName(“EMENU-手持pos”); //设置请求头，如果没有请求头，可以不用设置 config.setRequestHeaders( ApiReqHeader.header().setName(“Authorization”).setType(“string”).setDesc(“登陆后获取的jwt”) );

## 注意事项 ##

# 参考 #

https://blog.csdn.net/qq\_28911061/article/details/118838228  
https://blog.csdn.net/shalousun/article/details/101865769