SpringBoot 集成接口文档，老鸟们也被打脸了！

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

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

@Configuration

public class WebMvcAutoConfig implements WebMvcConfigurer {

@Bean

public 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”: “-”,

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

最后

这份《“java高分面试指南”-25分类227页1000+题50w+字解析》同样可分享给有需要的朋友，感兴趣的伙伴们可挑战一下自我，在不看答案解析的情况，测试测试自己的解题水平，这样也能达到事半功倍的效果！（好东西要大家一起看才香）

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门即可获取！
要的朋友，感兴趣的伙伴们可挑战一下自我，在不看答案解析的情况，测试测试自己的解题水平，这样也能达到事半功倍的效果！（好东西要大家一起看才香）

[外链图片转存中…(img-lWcnLvLy-1712202703625)]

[外链图片转存中…(img-TVT6VNQW-1712202703625)]

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门即可获取！