缺什么补什么:别把接口文档写成甩锅工具
很多后端写完 SpringBoot 接口,习惯性把方法参数往代码注释里一扔,前端联调时再口头补几句,出问题就互相扯皮。这门课就是针对这种“文档靠口头、改动不同步”的毛病,直接拿 Swagger2 开刀。它不跟你讲一堆 RESTful 设计哲学,而是解决一个很具体的事:怎么在 SpringBoot 项目里把接口文档自动生成出来,并且让接口入参、出参、路径说明跟着代码走,改了代码文档就跟着变。如果你现在还在手写 Markdown 交付接口,或者每次改完字段忘了通知前端,那这就是你的能力缺口。适合的基础很明确:你得会搭 SpringBoot 项目、会写基础 Controller,但没真正用过或者没配明白过 Swagger。
先看哪几块,怎么和资料配合练
别按顺序从头啃,建议先抓三块。第一块是快速启用和启动模块配置,也就是资料里关于怎么把依赖加进来、怎么让文档在本地跑起来的部分,先把页面调出来看到效果,比看十分钟介绍管用。第二块是抽取可配置项,这块容易被忽略,但实际项目里你不可能把所有开关都堆死在启动类,得知道怎么把文档的开关、扫描包路径抽成可配置参数,方便不同环境区分。第三块是 Controller 和 Model 常用注解,这是重点,得对着资料里的 Mock 项目结构边看边敲,别光听。练习方式很简单:自己起一个两三个接口的小模块,把每个接口的参数用注解标清楚,故意改一个字段名,刷新文档看它有没有同步变化,再试着把生产环境文档关掉。资料包里的项目结构就是给你对照着抄和改的,不要只看不动手。
学完能独立回答什么
看完别急着收藏,先自问几个问题:Swagger 依赖加进来之后,默认访问路径是什么、怎么改?怎么让某个接口在文档里不显示?Model 里的字段说明怎么加、嵌套对象的注解写在哪个层级?多环境部署时怎么做到开发环境开文档、生产环境关掉?这几个问题能不查资料答上来,说明你真会用了。学完之后你应该能独立干一件事:拿到一个新的 SpringBoot 模块,半小时内把接口文档配好、注解补全、环境开关做好,交付给前端一个能直接试请求的页面。这不是什么高深技能,但它是后端协作的基本盘,缺这一块就别说自己接口写得规范。
课程目录
1 课程介绍 (06:36) 2 Mock项目结构介绍 (04:29) 3 快速启用Swagger (05:32) 4 启动模块配置讲解 (07:11) 5 抽取可配置项 (07:19) 6 Controller和Model常用注解讲解 (17:50)





