目录
一.什么是Swagger？
二.Swagger的使用操作流程：
1.在pom.xml配置文件导入 Knife4j 的依赖：
2.在config配置类中加入 Knife4j 的相关配置并设置静态资源映射（否则接口文档无法访问）：
三.Swagger的四个常用注解：
1.注解介绍：
2.注解代码演示：
四.Swagger接口文档的效果展示：
一.什么是Swagger？
使用Swagger的时候，按照它的规范去定义接口以及接口相关的信息，就可以做到生成接口文档，以及在线接口调试页面。
官网：https://swagger.io/
Knife4j是为Java MVC框架集成Swagger生成的Api文档的增强解决方案。
二.Swagger的使用操作流程：
1.在pom.xml配置文件导入 Knife4j 的依赖：
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>2.在config配置类中加入 Knife4j 的相关配置并设置静态资源映射（否则接口文档无法访问）：
@Configuration
@Slf4j
public class WebMvcConfiguration extends WebMvcConfigurationSupport {
/**
* 通过knife4j生成接口文档
* @return
*/
@Bean
public Docket docket1() {
ApiInfo apiInfo = new ApiInfoBuilder()
.title("****项目接口文档")
.version("2.0")
.description("****项目接口文档")
.build();
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.groupName("管理端接口")
.apiInfo(apiInfo)
.select()
//指定生成接口需要扫描的包
.apis(RequestHandlerSelectors.basePackage("com.sky.controller.admin"))
.paths(PathSelectors.any())
.build();
return docket;
}
/**
* 设置静态资源映射
* @param registry
*/
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");//我们就可以通过url为localhost:8080/doc.html的请求路径查阅接口文档，而生成完接口文档后，这些文件就会放在classpath:/META-INF/resources/路径下
}
}三.Swagger的四个常用注解：
1.注解介绍：
| 注解 | 说明 |
|---|---|
| @Api | 用在类上，说明该类的作用（例如Controller来表示对类的说明） |
| @ApiOperation | 注解来给API增加方法说明（例如Controller的方法来说明方法的用途与作用） |
| @ApiModel | 用在类上，描述一个Model的信息（例如entity,DTO,VO）（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候） |
| @ApiModelProperty | 用在属性上，描述一个model的属性 |
2.注解代码演示：
像下面代码一样将注解加在类或方法的上面并加入字符串进行说明。
@RestController("userSetmealController")
@RequestMapping("/user/setmeal")
@Api(tags = "C端-套餐浏览接口")
public class SetmealController {
@Autowired
private SetmealService setmealService;
@GetMapping("/list")
@ApiOperation("根据分类id查询套餐")
@Cacheable(cacheNames = "setmealCache" , key = "#categoryId") //key为 setmealCache::100
public Result<List<Setmeal>> list(Long categoryId) {
Setmeal setmeal = new Setmeal();
setmeal.setCategoryId(categoryId);
setmeal.setStatus(StatusConstant.ENABLE);
List<Setmeal> list = setmealService.list(setmeal);
return Result.success(list);
}
}四.Swagger接口文档的效果展示：
我们可以通过下面这样的整洁页面来调用接口进行测试 - >
随后我们就明白可以通过Swagger来代替Postman进行后端的接口测试。
好了，本期内容就介绍到这里，Javaweb的知识还在生成中，记得三连支持以便找不到更多精彩内容，好了感谢收看！！！
