swagger註釋@API詳細說明

時間 2021-05-19

標籤 html spring restful 框架測試 this spa rest code 欄目 HTML 简体版

原文原文鏈接

swagger註釋@API詳細說明

swagger是當前最好用的Restful API文檔生成的開源項目,經過swagger-spring項目實現了springMVC框架的無縫集成功能,方便生成restful風格的接口文檔,html

同時,swagger-ui還能夠測試spring restful風格的接口功能spring

做用範圍 API 使用位置restful

對象屬性 @ApiModelProperty 用在參數對象的字段上框架

協議集描述 @Api 用在Conntroller類上測試

協議描述 @ApiOperation 用在controller方法上ui

Response集 @ApiResponses 用在controller方法上this

Response @ApiResponse 用在@ApiResponses裏面spa

非對象參數集 @ApilmplicitParams 用在controller方法上rest

非對象參數描述code

@ApiImplicitParam

用在@ApiImplicitParams的方法裏邊

描述返回對象的意義

@ApiModel

用在返回對象類上

@ApiModelProperty的用法

value–字段說明
name–重寫屬性名字
dataType–重寫屬性類型
required–是否必填
example–舉例說明
hidden–隱藏

// 我這個用在實體類的get()方法上了
/**
   * 獲取城市編號
   * @return 城市編號
   */
   @ApiModelProperty(value="城市編號",example="058",required=true)
   public String getCode() {
       return code;
   }
   /**
   * 設置城市編號
   * @param code 城市編號
   */
   public void setCode(String code) {
       this.code = code;
   }

   /**
   * 獲取城市名稱
   * @return 城市名稱
   */
   @ApiModelProperty(value="城市名稱",example="guangZhou",required=true)
   public String getName() {
       return name;
   }