目录
1. 关于Knife4j
Knife4j是一款基于Swagger 2的在线API文档框架。
2. 基本使用
2.1 在项目中添加依赖
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.9</version>
</dependency>
(注)以上依赖项仅适用于Spring Boot 2.6(不含)之前的版本。
2.2 在配置文件中开启增强模式
在application.properties中添加:
knife4j.enable=true
2.3 自定义配置类
在项目的config文件夹(自己创建的用来存放项目的配置类)下创建 Knife4jConfiguration.class,并添加配置:
配置代码是相对固定的
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {
//指定Controller包路径
private String basePackage = "com.example.demo.controller";
//分组名称
private String groupName = "product";
//主机名
private String host = "http://localhost";
//标题
private String title = "Demo在线API文档";
//简介
private String description = "Demo在线API文档";
//服务条款URL
private String termsOfServiceUrl = "http://www.apache.org/licenses/LICENSE-2.0";
//联系人
private String contactName = "xxx";
//联系网址
private String contactUrl = "http://localhost";
//联系邮箱
private String contactEmail = "[email protected]";
//版本号
private String version = "1.0.0";
@Autowired
private OpenApiExtensionResolver openApiExtensionResolver;
@Bean
public Docket docket() {
String groupName = "1.0.0";
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.host(host)
.apiInfo(apiInfo())
.groupName(groupName)
.select()
.apis(RequestHandlerSelectors.basePackage(basePackage))
.paths(PathSelectors.any())
.build()
.extensions(openApiExtensionResolver.buildExtensions(groupName));
return docket;
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title(title)
.description(description)
.termsOfServiceUrl(termsOfServiceUrl)
.contact(new Contact(contactName, contactUrl, contactEmail))
.version(version)
.build();
}
}
2.4 访问
打开浏览器,输入 http://localhost:8080/doc.html 即可访问。(使用项目配置的地址和接口)
3. 详细配置
1)在控制器类上添加`@Api注解,配置`tags`属性,可以指定模块名称(API文档中的一级菜单中显示的名称
2)在处理请求的方法上添加@ApiOperation注解,配置value属性,可以指定业务名称(API文档中的一级菜单的子项显示的名称)
3)在处理请求的方法上添加@ApiOperationSupport`注解,配置`order`属性,取值为数值,可以指定业务的显示排序序号,将根据order属性值升序排列
例:
@Api(tags = "轮播图管理模块")
@RestController
@RequestMapping("/banners")
public class BannerController {
@Autowired
private IBannerService iBannerService;
@ApiOperation("添加轮播图")
@ApiOperationSupport(order=101)
@PostMapping("/addBanner")
public JsonResult addNewBanner(@RequestBody BannerDTO bannerDto){
iBannerService.addNewBanner(bannerDto);
return JsonResult.ok();
}
}
4)在处理请求的方法的POJO参数的属性上添加@ApiModelProperty注解,配置value属性,可以指定参数的说明,另外,还可以通过此注解的required属性配置此参数是否必须(并不具备检查功能,只是在API文档上显示为必须提交)
@Data
public class BannerDTO implements Serializable {
@ApiModelProperty(value="图片地址",required = true,example ="xxx")
private String imgUrl;
}