Spring Boot 2.x中Swagger接口有哪些分類,針對(duì)這個(gè)問(wèn)題,這篇文章詳細(xì)介紹了相對(duì)應(yīng)的分析和解答,希望可以幫助更多想解決這個(gè)問(wèn)題的小伙伴找到更簡(jiǎn)單易行的方法。
曹妃甸ssl適用于網(wǎng)站、小程序/APP、API接口等需要進(jìn)行數(shù)據(jù)傳輸應(yīng)用場(chǎng)景,ssl證書(shū)未來(lái)市場(chǎng)廣闊!成為成都創(chuàng)新互聯(lián)的ssl證書(shū)銷售渠道,可以享受市場(chǎng)價(jià)格4-6折優(yōu)惠!如果有意向歡迎電話聯(lián)系或者加微信:028-86922220(備注:SSL證書(shū)合作)期待與您的合作!
首先,我們通過(guò)一個(gè)簡(jiǎn)單的例子,來(lái)看一下默認(rèn)情況,Swagger是如何根據(jù)Controller來(lái)組織Tag與接口關(guān)系的。定義兩個(gè)Controller
,分別負(fù)責(zé)教師管理與學(xué)生管理接口,比如下面這樣:
@RestController @RequestMapping(value = "/teacher") static class TeacherController { @GetMapping("/xxx") public String xxx() { return "xxx"; } } @RestController @RequestMapping(value = "/student") static class StudentController { @ApiOperation("獲取學(xué)生清單") @GetMapping("/list") public String bbb() { return "bbb"; } @ApiOperation("獲取教某個(gè)學(xué)生的老師清單") @GetMapping("/his-teachers") public String ccc() { return "ccc"; } @ApiOperation("創(chuàng)建一個(gè)學(xué)生") @PostMapping("/aaa") public String aaa() { return "aaa"; } }
啟動(dòng)應(yīng)用之后,我們可以看到Swagger中這兩個(gè)Controller是這樣組織的:
圖中標(biāo)出了Swagger默認(rèn)生成的Tag
與Spring Boot中Controller
展示的內(nèi)容與位置。
接著,我們可以再試一下,通過(guò)@Api
注解來(lái)自定義Tag
,比如這樣:
@Api(tags = "教師管理") @RestController @RequestMapping(value = "/teacher") static class TeacherController { // ... } @Api(tags = "學(xué)生管理") @RestController @RequestMapping(value = "/student") static class StudentController { // ... }
再次啟動(dòng)應(yīng)用之后,我們就看到了如下的分組內(nèi)容,代碼中@Api
定義的tags
內(nèi)容替代了默認(rèn)產(chǎn)生的teacher-controller
和student-controller
。
到這里,我們還都只是使用了Tag
與Controller
一一對(duì)應(yīng)的情況,Swagger中還支持更靈活的分組!從@Api
注解的屬性中,相信聰明的讀者一定已經(jīng)發(fā)現(xiàn)tags
屬性其實(shí)是個(gè)數(shù)組類型:
我們可以通過(guò)定義同名的Tag
來(lái)匯總Controller
中的接口,比如我們可以定義一個(gè)Tag
為“教學(xué)管理”,讓這個(gè)分組同時(shí)包含教師管理和學(xué)生管理的所有接口,可以這樣來(lái)實(shí)現(xiàn):
@Api(tags = {"教師管理", "教學(xué)管理"}) @RestController @RequestMapping(value = "/teacher") static class TeacherController { // ... } @Api(tags = {"學(xué)生管理", "教學(xué)管理"}) @RestController @RequestMapping(value = "/student") static class StudentController { // ... }
最終效果如下:
通過(guò)@Api
可以實(shí)現(xiàn)將Controller
中的接口合并到一個(gè)Tag
中,但是如果我們希望精確到某個(gè)接口的合并呢?比如這樣的需求:“教學(xué)管理”包含“教師管理”中所有接口以及“學(xué)生管理”管理中的“獲取學(xué)生清單”接口(不是全部接口)。
那么上面的實(shí)現(xiàn)方式就無(wú)法滿足了。這時(shí)候發(fā),我們可以通過(guò)使用@ApiOperation
注解中的tags
屬性做更細(xì)粒度的接口分類定義,比如上面的需求就可以這樣子寫:
@Api(tags = {"教師管理","教學(xué)管理"}) @RestController @RequestMapping(value = "/teacher") static class TeacherController { @ApiOperation(value = "xxx") @GetMapping("/xxx") public String xxx() { return "xxx"; } } @Api(tags = {"學(xué)生管理"}) @RestController @RequestMapping(value = "/student") static class StudentController { @ApiOperation(value = "獲取學(xué)生清單", tags = "教學(xué)管理") @GetMapping("/list") public String bbb() { return "bbb"; } @ApiOperation("獲取教某個(gè)學(xué)生的老師清單") @GetMapping("/his-teachers") public String ccc() { return "ccc"; } @ApiOperation("創(chuàng)建一個(gè)學(xué)生") @PostMapping("/aaa") public String aaa() { return "aaa"; } }
效果如下圖所示:
在完成了接口分組之后,對(duì)于接口內(nèi)容的展現(xiàn)順序又是眾多用戶特別關(guān)注的點(diǎn),其中主要涉及三個(gè)方面:分組的排序、接口的排序以及參數(shù)的排序,下面我們就來(lái)逐個(gè)說(shuō)說(shuō)如何配置與使用。
關(guān)于分組排序,也就是Tag的排序。目前版本的Swagger支持并不太好,通過(guò)文檔我們可以找到關(guān)于Tag排序的配置方法。
第一種:原生Swagger用戶,可以通過(guò)如下方式:
第二種:Swagger Starter用戶,可以通過(guò)修改配置的方式:
swagger.ui-config.tags-sorter=alpha
似乎找到了希望,但是其實(shí)這塊并沒(méi)有什么可選項(xiàng),一看源碼便知:
public enum TagsSorter { ALPHA("alpha"); private final String value; TagsSorter(String value) { this.value = value; } @JsonValue public String getValue() { return value; } public static TagsSorter of(String name) { for (TagsSorter tagsSorter : TagsSorter.values()) { if (tagsSorter.value.equals(name)) { return tagsSorter; } } return null; } }
是的,Swagger只提供了一個(gè)選項(xiàng),就是按字母順序排列。那么我們要如何實(shí)現(xiàn)排序呢?這里筆者給一個(gè)不需要擴(kuò)展源碼,僅依靠使用方式的定義來(lái)實(shí)現(xiàn)排序的建議:為Tag的命名做編號(hào)。比如:
@Api(tags = {"1-教師管理","3-教學(xué)管理"}) @RestController @RequestMapping(value = "/teacher") static class TeacherController { // ... } @Api(tags = {"2-學(xué)生管理"}) @RestController @RequestMapping(value = "/student") static class StudentController { @ApiOperation(value = "獲取學(xué)生清單", tags = "3-教學(xué)管理") @GetMapping("/list") public String bbb() { return "bbb"; } // ... }
由于原本存在按字母排序的機(jī)制在,通過(guò)命名中增加數(shù)字來(lái)幫助排序,可以簡(jiǎn)單而粗暴的解決分組問(wèn)題,最后效果如下:
在完成了分組排序問(wèn)題(雖然不太優(yōu)雅...)之后,在來(lái)看看同一分組內(nèi)各個(gè)接口該如何實(shí)現(xiàn)排序。同樣的,凡事先查文檔,可以看到Swagger也提供了相應(yīng)的配置,下面也分兩種配置方式介紹:
第一種:原生Swagger用戶,可以通過(guò)如下方式:
第二種:Swagger Starter用戶,可以通過(guò)修改配置的方式:
swagger.ui-config.operations-sorter=alpha
很慶幸,這個(gè)配置不像Tag的排序配置沒(méi)有可選項(xiàng)。它提供了兩個(gè)配置項(xiàng):alpha
和method
,分別代表了按字母表排序以及按方法定義順序排序。當(dāng)我們不配置的時(shí)候,改配置默認(rèn)為alpha
。兩種配置的效果對(duì)比如下圖所示:
完成了接口的排序之后,更細(xì)粒度的就是請(qǐng)求參數(shù)的排序了。默認(rèn)情況下,Swagger對(duì)Model參數(shù)內(nèi)容的展現(xiàn)也是按字母順序排列的。所以之前教程中的User對(duì)象在文章中展現(xiàn)如下:
如果我們希望可以按照Model中定義的成員變量順序來(lái)展現(xiàn),那么需要我們通過(guò)@ApiModelProperty
注解的position
參數(shù)來(lái)實(shí)現(xiàn)位置的設(shè)置,比如:
@Data @ApiModel(description = "用戶實(shí)體") public class User { @ApiModelProperty(value = "用戶編號(hào)", position = 1) private Long id; @NotNull @Size(min = 2, max = 5) @ApiModelProperty(value = "用戶姓名", position = 2) private String name; @NotNull @Max(100) @Min(10) @ApiModelProperty(value = "用戶年齡", position = 3) private Integer age; @NotNull @Email @ApiModelProperty(value = "用戶郵箱", position = 4) private String email; }
最終效果如下:
關(guān)于Spring Boot 2.x中Swagger接口有哪些分類問(wèn)題的解答就分享到這里了,希望以上內(nèi)容可以對(duì)大家有一定的幫助,如果你還有很多疑惑沒(méi)有解開(kāi),可以關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道了解更多相關(guān)知識(shí)。
分享文章:SpringBoot2.x中Swagger接口有哪些分類
文章地址:http://chinadenli.net/article48/gpcsep.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供手機(jī)網(wǎng)站建設(shè)、面包屑導(dǎo)航、關(guān)鍵詞優(yōu)化、營(yíng)銷型網(wǎng)站建設(shè)、軟件開(kāi)發(fā)、品牌網(wǎng)站制作
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來(lái)源: 創(chuàng)新互聯(lián)