之前我在SpringBoot老鸟系列中专门花了大量的篇幅详细介绍如何集成Swagger,以及如何对Swagger进行扩展让其支持接口参数分组功能。详情可见:SpringBoot 如何生成接口文档,老鸟们都这么玩的!

可是当我接触到另一个接口文档工具 smart-doc后,我觉得它比Swagger更适合集成在项目中,更适合老鸟们。今天我们就来介绍一下smart-doc组件的使用,作为对老鸟系列文章的一个补充。

swagger vs smart-doc

首先我们先看一下Swagger组件目前存在的主要问题:

  1. Swagger的代码侵入性比较强

    这个很容易理解,要让Swagger生成接口文档必须要给方法或字段添加对应的注解,是存在代码侵入的。

  2. 原生swagger不支持接口的参数分组

    对于有做参数分组的接口,原生的Swagger并未支持,虽然我们通过扩展其组件可以让其支持参数分组,但是毕竟要开发,而且还未支持最新的Swagger3版本。

那作为对比,smart-doc 是基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释的写,smart-doc就能帮你生成一个简易明了的markdown 或是一个像GitBook样式的静态html文档。官方地址:https://gitee.com/smart-doc-team/smart-doc

简单罗列一下smart-doc的优点:

  • 零注解、零学习成本、只需要写标准java注释即可生成文档。
  • 基于源代码接口定义自动推导,强大的返回结构推导。
  • 支持Spring MVC,Spring Boot,Spring Boot Web Flux(controller书写方式)。
  • 支持Callable,Future,CompletableFuture等异步接口返回的推导。
  • 支持JavaBean上的JSR303参数校验规范,支持参数分组。
  • 对一些常用字段定义能够生成有效的模拟值。

接下来我们来看看SpringBoot中如何集成smart-doc。

SpringBoot集成 smart-doc

smart-doc支持多种方式生成接口文档:maven插件、gradle插件、单元测试(不推荐),这里我才用的是基于maven插件生成,步骤如下:

  1. 引入依赖,版本选择最新版本
<!--引入smart-doc-->
<plugin><groupId>com.github.shalousun</groupId><artifactId>smart-doc-maven-plugin</artifactId><version>2.2.7</version><configuration><configFile>./src/main/resources/smart-doc.json</configFile><projectName>Smart-Doc初体验</projectName></configuration>
</plugin>

重点在 configFile中指定smart-doc配置文件 smart-doc.json

  1. 新建配置文件smart-doc.json
{"outPath": "src/main/resources/static/doc"
}

指定smart-doc生成的文档路径,其他配置项可以参考官方wiki。

  1. 通过执行maven 命令生成对应的接口文档
//生成html
mvn -Dfile.encoding=UTF-8 smart-doc:html

当然也可以通过idea中的maven插件生成


4. 访问接口文档

生成接口文档后我们通过 http://localhost:8080/doc/api.html查看,效果如下:


看到这里的同学可能会呵呵一笑,就这?啥也没有呀!这还想让我替换Swagger?

别急,刚刚只是体验了smart-doc的基础功能,接下来我们通过丰富smart-doc的配置文件内容来增强其功能。

功能增强

1. 开启调试

一个优秀的接口文档工具调试功能必不能少,smart-doc支持在线调试功能,只需要加入如下几个配置项:

{"serverUrl": "http://localhost:8080",      -- 服务器地址"allInOne": true,                -- 是否将文档合并到一个文件中,一般推荐为true"outPath": "src/main/resources/static/doc",  -- 指定文档的输出路径"createDebugPage": true,           -- 开启测试"allInOneDocFileName":"index.html",      -- 自定义文档名称"projectName": "初识smart-doc"        -- 项目名称
}

通过"createDebugPage": true 开启debug功能,在让生成smart-doc生成文档时直接放入到 static/doc/下,这样可以直接启动程序访问页面 http://localhost:8080/doc/index.html进行开发调试。

有的开发人员直接在idea中使用【Open In Browser】打开smart-doc生成的debug页面,如果非要这做,前端js请求后台接口时就出现了跨域。因此你需要在后端配置跨域。

这里以 SpringBoot2.3.x 为例配置后端跨域:

@Configuration
public class WebMvcAutoConfig implements WebMvcConfigurer {@Beanpublic CorsFilter corsFilter() {final UrlBasedCorsConfigurationSource urlBasedCorsConfigurationSource = new UrlBasedCorsConfigurationSource();final CorsConfiguration corsConfiguration = new CorsConfiguration();/* 是否允许请求带有验证信息 */corsConfiguration.setAllowCredentials(true);/* 允许访问的客户端域名 */corsConfiguration.addAllowedOrigin("*");/* 允许服务端访问的客户端请求头 */corsConfiguration.addAllowedHeader("*");/* 允许访问的方法名,GET POST等 */corsConfiguration.addAllowedMethod("*");urlBasedCorsConfigurationSource.registerCorsConfiguration("/**", corsConfiguration);return new CorsFilter(urlBasedCorsConfigurationSource);}
}

开启跨域后我们就可以直接在静态接口页面中进行调试了。

2. 通用响应体

在 “SpringBoot 如何统一后端返回格式?老鸟们都是这样玩的!”一文中我们通过实现 ResponseBodyAdvice对所有返回值进行了包装,给前端返回统一的数据结构ResultData,我们需要让其在接口文档中也有此功能,在配置文件追加配置内容:

{"responseBodyAdvice":{            -- 通用响应体"className":"com.jianzh5.blog.base.ResultData"}
}

3. 自定义Header

在前后端分离项目中我们一般需要在请求接口时设置一个请求头,如token,Authorization等…后端根据请求头判断是否为系统合法用户,目前smart-doc也对其提供了支持。

在smart-doc配置文件 smart-doc.json中继续追加如下配置内容:

"requestHeaders": [ //设置请求头,没有需求可以不设置{"name": "token",//请求头名称"type": "string",//请求头类型"desc": "自定义请求头 - token",//请求头描述信息"value":"123456",//不设置默认null"required": false,//是否必须"since": "-",//什么版本添加的改请求头"pathPatterns": "/smart/say",//只有以/smart/say 开头的url才会有此请求头"excludePathPatterns":"/smart/add,/smart/edit" // url=/app/page/将不会有该请求头}
]

效果如下:

4. 参数分组

演示一下smart-doc对于参数分组的支持


新增操作时,age、level为必填项,sex为非必填。


编辑操作时,id,appid,leven为必填项,sex为非必填。

通过上面的效果可以看出smart-doc对于参数分组是完全支持的。

5. idea配置doc

自定义的tag默认是不会自动提示的,需要用户在idea中进行设置。设置好后即可使用,下面以设置smart-doc自定义的mock tag为例,设置操作如下:

### 6. 完整配置

附上完整配置,如果还需要其他配置大家可以参考wiki自行引入。

{"serverUrl": "http://localhost:8080","allInOne": true,"outPath": "src/main/resources/static/doc","createDebugPage": true,"allInOneDocFileName":"index.html","projectName": "初识smart-doc","packageFilters": "com.jianzh5.blog.smartdoc.*","errorCodeDictionaries": [{"title": "title","enumClassName": "com.jianzh5.blog.base.ReturnCode","codeField": "code","descField": "message"}],"responseBodyAdvice":{"className":"com.jianzh5.blog.base.ResultData"},"requestHeaders": [{"name": "token","type": "string","desc": "自定义请求头 - token","value":"123456","required": false,"since": "-","pathPatterns": "/smart/say","excludePathPatterns":"/smart/add,/smart/edit"}]
}

小结

其实没什么可总结的,smart-doc使用非常简单,官方文档也非常详细,只要你会写标准的java注释就可以给你生成详细的接口文档。(如果你说你不会写注释,那这篇文章可能不太适合你) 而且在引入smart-doc后还可以强制要求开发人员给接口编写注释,保证团队代码风格不会出现很大差异。

老鸟系列源码已经上传至GitHub,需要的点击下方卡片关注并回复关键字 0923 获取

SpringBoot 集成接口文档,老鸟们也被打脸了!相关推荐

  1. springboot生成接口文档

    当我们在使用Spring MVC写接口的时候,为了生成API文档,为了方便整合Swagger,都是用这个SpringFox的这套封装.但是,自从2.9.2版本更新之后,就一直没有什么动静,也没有更上S ...

  2. SpringBoot+Knif4j接口文档,出现No mapping for GET /doc.html

    报错如下: 解决方法:把下面的代码直接复制粘贴到项目里. import org.springframework.boot.autoconfigure.SpringBootApplication; im ...

  3. 【接口测试基础】第四篇 | 接口测试流程及接口文档解析

    接口测试流程 1.分析需求,产生需求文档(产品) 2.开发产生接口文档,测试解析接口文档 3.测试产生测试用例(送审) 4.测试执行测试用例 工具:postman,jmeter 代码:python+R ...

  4. SpringBoot 如何生成接口文档,老鸟们都这么玩的!

    为什么要用Swagger ? " 作为一名程序员,我们最讨厌两件事:1. 别人不写注释.2. 自己写注释. 而作为一名接口开发者,我们同样讨厌两件事:1. 别人不写接口文档,文档不及时更新. ...

  5. springboot 接口文档 请求 enum_Spring Boot集成SpringFox 3:生成Swagger接口文档

    SpringFox介绍 SpringFox是一个开源的API Doc的框架, 它的前身是swagger-springmvc,可以将我们的Controller中的方法以文档的形式展现.官方定义为:Aut ...

  6. SpringBoot集成knife4j接口文档

    knife4j介绍 knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案. 其他的详情请看官方文档: knife4j官方文档 首先创建一个spring boot 项目, ...

  7. springboot项目集成java接口文档生成工具knife4j

    knifie knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望她能像一把匕首一样小巧,轻量,并 ...

  8. SpringBoot集成knife4j实现Swagger接口文档

    前言:如果你是后台开发,提供restful接口给前端,建议你使用Swagger3提供restful的接口文档自动生成和在线接口调试.knife4j是对Swagger进一步封装,其优化了API文档的UI ...

  9. SpringBoot集成swagger生成在线接口文档

    SpringBoot集成swagger生成在线接口文档 集成maven依赖 <dependency><groupId>io.springfox</groupId>& ...

最新文章

  1. android中button点击频率控制
  2. jdk中一些常见命令
  3. MyEclipse + Maven开发Web工程的详细配置过程
  4. Python实现模板
  5. 洛谷P1085不高兴的津津
  6. activiti jbpm相关资源
  7. python多线程写同一个文件_Python多线程快速写入文件,python,飞速
  8. 通过Repository Manager 1.3来管理戴尔驱动程序更新
  9. 所有controller interceptor_filter、interceptor、aspect不知如何选择
  10. vue中的浏览量_Laravel 5.3和vuejs实现文章浏览次数问题
  11. 智能电动汽车充电桩去除安全隐患提高充电效率
  12. 【AD封装】插件电感,变压器(带3D)
  13. doris core安装报错Makefile:158: recipe for target 'processor.o' failed make: *** [processor.o] Error 1
  14. CAD不支持实时调试
  15. selenium2java 截图保存桌面(内含一坑)
  16. html网页中如何给文字加入下划线
  17. MTK Camera 基础知识
  18. MySQL调优篇:单机数据库如何在高并发场景下健步如飞?
  19. register关键字的使用
  20. 融360叶大清:互联网金融创新之路

热门文章

  1. 企业邮局在koomail里的设置方法
  2. Android基础教程(十)build.gradle文件
  3. 计算机 打开3389端口,3389端口修改和打开【图文教程】
  4. ffmpeg转码php配置,PHP+ffmpeg+nginx的配置实现视频转码(转)
  5. 手把手教你solidworks重力下落物体动画制作
  6. 【NOIP2017提高A组模拟8.25】夜莺与玫瑰
  7. 郑州大学计算机新媒体专业介绍,数字媒体专业介绍
  8. 速取,3D建模速成入门到高级教程(附软件安装包)
  9. STM32遇到的坑!你知道几个?
  10. deepin20系统选择手动安装盘_拯救老Macbook Air笔记本经验分享,用优盘安装最新苹果系统...