再見丑陋的 SwaggerUI，這款A(yù)PI文檔生成神器界面更炫酷，逼格更高！
往期熱門文章：
1、員工春節(jié)加班猝死！反轉(zhuǎn)了，B站深夜發(fā)長文回應(yīng)！ 2、1 個月崩 3 次！盤點一下 2021 年的 10 個宕機名場面 3、這類視頻遭破解，大量上傳B站，行為惡劣！ 4、滴滴程序員被親戚鄙視：年薪八十萬還不如二本教書的... 5、IT界驚現(xiàn)文豪！華為領(lǐng)導(dǎo)及阿里P10遭吐槽
一、關(guān)于 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("編程貓學(xué)習(xí)網(wǎng)站的?admin?管理端?API")
????????????????.description("codingmore")
????????????????.contact(new?Contact("沉默王二&石磊",?"https://tobebetterjavaer.com",?"[email protected]"))
????????????????.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?ResultObject?delete(long?postsId)? {
????????return?ResultObject.success(postsService.removePostsById(postsId)???"刪除成功"?:?"刪除失敗");
????}
}
@Api 注解用在類上，該注解將一個 Controller 類標(biāo)記位一個 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，如果有權(quán)限限制的話，記得開白名單。
1、《歷史文章分類導(dǎo)讀列表！精選優(yōu)秀博文都在這里了！》
2、上海地鐵乘車碼“變紅”，嚇倒一眾乘客，官方：為營造節(jié)日氣氛…… 3、Spring Boot 項目打成 .exe 程序？實戰(zhàn)來了！ 4、Spring Boot太重，Vert.x真香！ 5、中美程序員不完全對比 6、Spring Boot 3.0 M1 發(fā)布，正式棄用 Java 8，最低要求 Java 17。。。 7、一個“扛住100億次請求”的春晚紅包系統(tǒng) 8、你覺得HTTPS能防止重放攻擊嗎? 9、數(shù)據(jù)一致性，為什么不推薦雙寫? 10、Spring Boot實現(xiàn)抽獎大轉(zhuǎn)盤
評論
圖片
表情