[title]Knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案。[/title]
1.导入knife4j的maven坐标
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
</dependency>
2,在配置类中加入knife4j相关配置 configurition配置类里面 继承 WebMvcConfigurationSupport 类
/**
* 通过knife4j生成接口文档
*
* @return
*/
@Bean
public Docket docket() {
ApiInfo apiInfo = new ApiInfoBuilder()
.title("苍穹外卖项目接口文档")
.version("2.0")
.description("苍穹外卖项目接口文档")
.build();
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo).select()
.apis(RequestHandlerSelectors
.basePackage("com.sky.controller"))
.paths(PathSelectors.any())
.build();
return docket;
}
3,设置静态资源映射,否则接口文档页面无法访问
/**
* 设置静态资源映射
*
* @param registry
*/
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}
| 注解 | 说明 |
|---|---|
| @Api | 用在类上,例如Controller,表示对类的说明 |
| @ApiModel | 用在类上,例如entity、 DTO、vo |
| @ApiModelProperty | 用在属性上,描述属性信息 |
| @ApiOperation | 用在方法上,例如Controller的方法,说明方法的用途、作用 |
- THE END -
最后修改:2024年4月24日
一个记录开发笔记的社区
如若转载,请注明出处:/posts/knife4j-%e9%9b%86%e6%88%90java%e6%8e%a5%e5%8f%a3%e6%96%87%e6%a1%a3


评论区暂未迁移
旧站评论表还没有完全接入新版接口层,这里会继续按数据库方式补齐。