**1. 引入 springdoc-openapi-starter-webmvc-ui** ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.2.0</version> </dependency> ``` **2. 在 controller 层标记文档注解** ```java @RestController @Tag(name = "学生接口") public class StudentController { @Operation(summary = "根据名字获取") @GetMapping("/student/getByName") public String getByName(@Parameter(description = "输入名字", example = "张三") @RequestParam("name") String name) { return name; } } ``` **3. 访问文档** 1. 访问文档 UI 界面：http://localhost:8080/swagger-ui/index.html  2. 访问文档 json 信息：http://localhost:8080/v3/api-docs  3. 下载文档 yaml 信息：http://localhost:8080/v3/api-docs.yaml  >[info]提醒：如果使用了拦截器、或引入了 SpringSecurity 等权限框架，记得放通文档地址及静态资源。 ``` - /**/*.html - /**/*.css - /**/*.js - /**/api-docs/** ```