Swagger的原理及應(yīng)用

這篇文章主要講解了“Swagger的原理及應(yīng)用”，文中的講解內(nèi)容簡單清晰，易于學(xué)習(xí)與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學(xué)習(xí)“Swagger的原理及應(yīng)用”吧！

OpenAPI規(guī)范是Linux基金會(huì)的一個(gè)項(xiàng)目，試圖通過定義一種用來描述API格式或API定義的語言，來規(guī)范RESTful服務(wù)開發(fā)過程。

Swagger是全球最大的OpenAPI規(guī)范API開發(fā)工具框架，支持從設(shè)計(jì)到文檔到測試和部署到整個(gè)API生命周期的開發(fā)。Spring Boot可以集成Swagger，生成Swagger接口。

在Java類中添加Swagger的注解即可生成Swagger接口。

常用的Swagger注解：

@Api：修飾整個(gè)類，描述Controller的作用，

@ApiOperation：描述一個(gè)類的一個(gè)方法，或者說一個(gè)接口

@ApiParam：單個(gè)參數(shù)描述

@ApiModel：用對象來接收參數(shù)

@ApiModelProperty：用對象接收參數(shù)時(shí)，描述對象的一個(gè)字段

@ApiResponse：HTTP響應(yīng)其中1個(gè)描述

@ApiResponses：HTTP響應(yīng)整體描述

@ApiIgnore：使用該注解忽略這個(gè)API

Swagger接口生成工作原理：

1、系統(tǒng)啟動(dòng)時(shí)，掃描Swagger的配置類

2、在此類中指定來要掃描的包路徑，找到在此包下及子包下標(biāo)記@RestController注解的controller類

3、根據(jù)controller類中的Swagger注解生成接口文檔

啟動(dòng)項(xiàng)目，訪問項(xiàng)目虛擬路徑/swagger-ui，查看生成的項(xiàng)目

@ApiError：發(fā)送錯(cuò)誤返回的信息

@ApiImplicitParam：一個(gè)請求參數(shù)

@ApiImplicitParams：多個(gè)請求參數(shù)

感謝各位的閱讀，以上就是“Swagger的原理及應(yīng)用”的內(nèi)容了，經(jīng)過本文的學(xué)習(xí)后，相信大家對Swagger的原理及應(yīng)用這一問題有了更深刻的體會(huì)，具體使用情況還需要大家實(shí)踐驗(yàn)證。這里是億速云，小編將為大家推送更多相關(guān)知識(shí)點(diǎn)的文章，歡迎關(guān)注！