欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

springboot swagger2注解使用的教程

 更新時間:2020年05月13日 10:21:46   作者:miraclewu  
這篇文章主要介紹了springboot swagger2注解使用,本文給大家介紹的非常詳細,對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下

swagger2 注解整體說明  最近在使用Swagger的時候忘記了注解的用法,特此記錄一下。

@Api:用在請求的類上,表示對類的說明
   tags="說明該類的作用,可以在UI界面上看到的注解"
   value="該參數(shù)沒什么意義,在UI界面上也看到,所以不需要配置"
 
 @ApiOperation:用在請求的方法上,說明方法的用途、作用
   value="說明方法的用途、作用"
   notes="方法的備注說明"
 
 @ApiImplicitParams:用在請求的方法上,表示一組參數(shù)說明
   @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一個請求參數(shù)的各個方面
     name:參數(shù)名
     value:參數(shù)的漢字說明、解釋
     required:參數(shù)是否必須傳
     paramType:參數(shù)放在哪個地方
       · header --> 請求參數(shù)的獲?。篅RequestHeader
       · query --> 請求參數(shù)的獲取:@RequestParam
       · path(用于restful接口)--> 請求參數(shù)的獲?。篅PathVariable
       · body(不常用)
       · form(不常用)  
     dataType:參數(shù)類型,默認String,其它值dataType="Integer"    
     defaultValue:參數(shù)的默認值
 
 @ApiResponses:用在請求的方法上,表示一組響應(yīng)
   @ApiResponse:用在@ApiResponses中,一般用于表達一個錯誤的響應(yīng)信息
     code:數(shù)字,例如400
     message:信息,例如"請求參數(shù)沒填好"
     response:拋出異常的類
 
 @ApiModel:用于響應(yīng)類上,表示一個返回響應(yīng)數(shù)據(jù)的信息
       (這種一般用在post創(chuàng)建的時候,使用@RequestBody這樣的場景,
       請求參數(shù)無法使用@ApiImplicitParam注解進行描述的時候)
   @ApiModelProperty:用在屬性上,描述響應(yīng)類的屬性

1. @Api:用在請求的類上,說明該類的作用

 @Api:用在請求的類上,說明該類的作用
   tags="說明該類的作用"
   value="該參數(shù)沒什么意義,所以不需要配置"

  示例:

@Api(tags="APP用戶注冊Controller")

2. @ApiOperation:用在請求的方法上,說明方法的作用

 @ApiOperation:"用在請求的方法上,說明方法的作用"
   value="說明方法的作用"
   notes="方法的備注說明"

  示例:

@ApiOperation(value="用戶注冊",notes="手機號、密碼都是必輸項,年齡隨邊填,但必須是數(shù)字")

3. @ApiImplicitParams:用在請求的方法上,包含一組參數(shù)說明

 @ApiImplicitParams:用在請求的方法上,包含一組參數(shù)說明
   @ApiImplicitParam:用在 @ApiImplicitParams 注解中,指定一個請求參數(shù)的配置信息    
     name:參數(shù)名
     value:參數(shù)的漢字說明、解釋
     required:參數(shù)是否必須傳
     paramType:參數(shù)放在哪個地方
       · header --> 請求參數(shù)的獲取:@RequestHeader
       · query --> 請求參數(shù)的獲?。篅RequestParam
       · path(用于restful接口)--> 請求參數(shù)的獲取:@PathVariable
       · body(不常用)
       · form(不常用)  
     dataType:參數(shù)類型,默認String,其它值dataType="Integer"    
     defaultValue:參數(shù)的默認值

  示例:

 @ApiImplicitParams({
   @ApiImplicitParam(name="mobile",value="手機號",required=true,paramType="form"),
   @ApiImplicitParam(name="password",value="密碼",required=true,paramType="form"),
   @ApiImplicitParam(name="age",value="年齡",required=true,paramType="form",dataType="Integer")
})

4. @ApiResponses:用于請求的方法上,表示一組響應(yīng)

 @ApiResponses:用于請求的方法上,表示一組響應(yīng)
   @ApiResponse:用在@ApiResponses中,一般用于表達一個錯誤的響應(yīng)信息
     code:數(shù)字,例如400
     message:信息,例如"請求參數(shù)沒填好"
     response:拋出異常的類

示例:

@ApiOperation(value = "select1請求",notes = "多個參數(shù),多種的查詢參數(shù)類型")
 @ApiResponses({
   @ApiResponse(code=400,message="請求參數(shù)沒填好"),
   @ApiResponse(code=404,message="請求路徑?jīng)]有或頁面跳轉(zhuǎn)路徑不對")
 })

5. @ApiModel:用于響應(yīng)類上,表示一個返回響應(yīng)數(shù)據(jù)的信息

 @ApiModel:用于響應(yīng)類上,表示一個返回響應(yīng)數(shù)據(jù)的信息
       (這種一般用在post創(chuàng)建的時候,使用@RequestBody這樣的場景,
       請求參數(shù)無法使用@ApiImplicitParam注解進行描述的時候)
   @ApiModelProperty:用在屬性上,描述響應(yīng)類的屬性

  示例:

 import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiModelProperty;
 import java.io.Serializable;
 @ApiModel(description= "返回響應(yīng)數(shù)據(jù)")
 public class RestMessage implements Serializable{
   @ApiModelProperty(value = "是否成功")
   private boolean success=true;
   @ApiModelProperty(value = "返回對象")
   private Object data;
   @ApiModelProperty(value = "錯誤編號")
   private Integer errCode;
   @ApiModelProperty(value = "錯誤信息")
   private String message;
   /* getter/setter */
 }

總結(jié)

到此這篇關(guān)于springboot swagger2注解使用的文章就介紹到這了,更多相關(guān)springboot swagger2注解使用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

  • 詳解Java中Collection集合的常用方法

    詳解Java中Collection集合的常用方法

    本篇文章給大家?guī)淼膬?nèi)容是關(guān)于Java中Collection集合的常用方法詳解,有一定的參考價值,有需要的朋友可以參考一下,希望對你有所幫助。下面我們就來學(xué)習(xí)一下吧
    2021-11-11
  • Mybatis如何自動生成sql語句

    Mybatis如何自動生成sql語句

    這篇文章主要介紹了Mybatis如何自動生成sql語句,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教
    2021-12-12
  • Java中內(nèi)部類的概念與分類詳解

    Java中內(nèi)部類的概念與分類詳解

    一個類的定義放在另一個類的內(nèi)部,這個類就叫做內(nèi)部類,下面這篇文章主要給大家介紹了關(guān)于Java中內(nèi)部類的概念與分類的相關(guān)資料,文中通過示例代碼介紹的非常詳細,需要的朋友可以參考下
    2021-09-09
  • 超詳細講解SpringCloud?Commons公共抽象的用法

    超詳細講解SpringCloud?Commons公共抽象的用法

    這篇文章主要介紹了超詳細講解SpringCloud?Commons公共抽象的用法,文中示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下
    2022-04-04
  • 詳細學(xué)習(xí)Java Cookie技術(shù)(用戶登錄、瀏覽、訪問權(quán)限)

    詳細學(xué)習(xí)Java Cookie技術(shù)(用戶登錄、瀏覽、訪問權(quán)限)

    這篇文章主要為大家詳細介紹了Java Cookie技術(shù),顯示用戶上次登錄的時間、顯示用戶最近瀏覽的若干個圖片(按比例縮放)等,感興趣的小伙伴們可以參考一下
    2016-08-08
  • SpringBoot請求處理之常用參數(shù)注解介紹與源碼分析

    SpringBoot請求處理之常用參數(shù)注解介紹與源碼分析

    SpringBoot是一種整合Spring技術(shù)棧的方式(或者說是框架),同時也是簡化Spring的一種快速開發(fā)的腳手架,本篇讓我們一起學(xué)習(xí)請求處理、常用注解和方法參數(shù)的小技巧
    2022-10-10
  • IntelliJ IDEA 詳細圖解最常用的配置(適合剛剛用的新人)

    IntelliJ IDEA 詳細圖解最常用的配置(適合剛剛用的新人)

    這篇文章主要介紹了IntelliJ IDEA 詳細圖解最常用的配置,本篇教程非常適合剛剛用的新人,本文圖文并茂給大家介紹的非常詳細,對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下
    2020-08-08
  • 基于SpringMVC對接前端參數(shù)注解

    基于SpringMVC對接前端參數(shù)注解

    這篇文章主要介紹了基于SpringMVC對接前端參數(shù)注解的使用,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教
    2023-09-09
  • SpringCloud hystrix服務(wù)降級概念介紹

    SpringCloud hystrix服務(wù)降級概念介紹

    什么是服務(wù)降級?當(dāng)服務(wù)器壓力劇增的情況下,根據(jù)實際業(yè)務(wù)情況及流量,對一些服務(wù)和頁面有策略的不處理或換種簡單的方式處理,從而釋放服務(wù)器資源以保證核心交易正常運作或高效運作
    2022-09-09
  • 基于java實現(xiàn)停車場管理系統(tǒng)

    基于java實現(xiàn)停車場管理系統(tǒng)

    這篇文章主要為大家詳細介紹了基于java實現(xiàn)停車場管理系統(tǒng),文中示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下
    2019-11-11

最新評論