再见丑陋的 SwaggerUI，这款API文档生成神器界面更炫酷，逼格更高！
Java后端技术
共 4377字，需浏览 9分钟
·
2022-02-14 06:19
往期热门文章：
1、员工春节加班猝死！反转了，B站深夜发长文回应！ 2、1 个月崩 3 次！盘点一下 2021 年的 10 个宕机名场面 3、这类视频遭破解，大量上传B站，行为恶劣！ 4、滴滴程序员被亲戚鄙视：年薪八十万还不如二本教书的... 5、IT界惊现文豪！华为领导及阿里P10遭吐槽
一、关于 Knife4j
https://doc.xiaominfo.com/knife4j/documentation/
https://gitee.com/xiaoym/knife4j
https://gitee.com/xiaoym/swagger-bootstrap-ui-demo
二、整合 Swagger
io.springfox
springfox-boot-starter
3.0.0
@Configuration
public class SwaggerConfig {
@Bean
public Docket docket() {
Docket docket = new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo()).enable(true)
.select()
//apis： 添加swagger接口提取范围
.apis(RequestHandlerSelectors.basePackage("com.codingmore.controller"))
.paths(PathSelectors.any())
.build();
return docket;
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("编程猫学习网站的 admin 管理端 API")
.description("codingmore")
.contact(new Contact("沉默王二&石磊", "https://tobebetterjavaer.com", "983436076@qq.com"))
.version("1.0")
.build();
}
}
http://localhost:9002/swagger-ui/
swagger-ui 就可以了。
@Controller
@Api(tags = "文章 ")
@RequestMapping("/posts")
public class PostsController {
@RequestMapping(value = "/delete", method = RequestMethod.GET)
@ResponseBody
@ApiOperation("删除")
public ResultObjectdelete(long postsId) {
return ResultObject.success(postsService.removePostsById(postsId) ? "删除成功" : "删除失败");
}
}
@Api 注解用在类上，该注解将一个 Controller 类标记位一个 Swagger 资源（API）。默认情况下，Swagger 只会扫描解析具有 @Api 注解的类。
@ApiOperation 注解用在方法上，该注解在指定的方法上，对一个方法进行描述。
三、整合 Knife4j
com.github.xiaoymin
knife4j-spring-boot-starter
3.0.2
@Configuration
@EnableOpenApi
public class SwaggerConfig {}
访问地址：http://localhost:9002/doc.html
secure:
ignored:
urls: #安全路径白名单
- /doc.html
- /swagger-ui/**
- /swagger/**
- /swagger-resources/**
- /**/v3/api-docs
四、Knife4j 的功能特点
五、尾声
https://doc.xiaominfo.com/knife4j/documentation/enhance.html
在 pom.xml 文件中把 springfox-boot-starter替换为knife4j-spring-boot-starter；访问地址由原来的 http://${host}:${port}/swagger-ui.html切换到http://${host}:${port}/doc.html，如果有权限限制的话，记得开白名单。
1、《历史文章分类导读列表！精选优秀博文都在这里了！》
2、上海地铁乘车码“变红”，吓倒一众乘客，官方：为营造节日气氛…… 3、Spring Boot 项目打成 .exe 程序？实战来了！ 4、Spring Boot太重，Vert.x真香！ 5、中美程序员不完全对比 6、Spring Boot 3.0 M1 发布，正式弃用 Java 8，最低要求 Java 17。。。 7、一个“扛住100亿次请求”的春晚红包系统 8、你觉得HTTPS能防止重放攻击吗? 9、数据一致性，为什么不推荐双写? 10、Spring Boot实现抽奖大转盘
评论