Swagger3註解使用

天下沒有收費的bug發表於2021-04-07

Swagger

這裡只簡單的說一下swagger的傳值，返回值時註解的使用演示。相關注解及說明見其他文章

接收引數方式1

我們常規接收引數，可以使用一個類，類裡面把屬性作為接收的引數，使用註解對屬性進行說明。但是這種傳參方式，我除錯的時候，支援前端的傳參方式為：form-data

例子如下：

因為這種方式我們用的不多，所以這裡就不展開來講

一般我們前端都是傳json資料過來後端，後端接收引數是直接用JSONObject或Map所以主要講一下第二種

接收引數方式2

前端傳參：json

後端接收：jsonObject或Map

對於這種JSONObject接收引數的，我們不能用第一種方式，此時應該用另外兩個註解來實現

注意：dataType屬性預設是String，如果要換成其他，比如int屬性，不能直接寫int或Interger，一定要加上全類名，不然會被解析成string型別。

程式碼如下：

 1      /**
 2       * 測試介面
 3       *
 4       * @param jsonObject 前端傳過來的引數
 5       * @return 無
 6       */
 7      @PostMapping("/test")
 8      @ApiOperation(value = "測試介面", httpMethod = "POST", notes = "測試，這是一個後端的測試介面")
 9      @ApiImplicitParams({
10              @ApiImplicitParam(value = "這是具體的引數1說明", name = "parm1", required = true, dataType = "String",
11                      paramType = "query"),
12              @ApiImplicitParam(value = "引數二是string型別", name = "parm2", required = true, dataType = "String",
13                      paramType = "query"),
14              @ApiImplicitParam(value = "引數三是int型別", name = "parm3", required = true, dataType = "java.lang.Integer",
15                      paramType = "query"),
16              @ApiImplicitParam(value = "引數四是布林型別", name = "parm4", required = true, dataType = "java.lang.Boolean",
17                      paramType = "query"),
18              @ApiImplicitParam(value = "引數五：0表示成功，1表示失敗", name = "parm5", required = true, dataType = "String",
19                      paramType = "query")
20      })
21      public JSONObject testParm(JSONObject jsonObject) {
22  
23          return null;
24  
25      }
26  
27  }

這樣子看，可能顯得程式碼略顯臃腫，但是我們寫程式碼的時候，把它摺疊起來就好了，效果如下

接下來，看一下swagger中的具體效果圖

響應引數

請求引數我們瞭解了，接下來我們看一下響應引數，首先所有的響應都要基於ResponseVo這個類。

 1 @Data
 2  @ApiModel()
 3  public class ResponseVo<T> implements Serializable {
 4      @ApiModelProperty(value = "預設時間")
 5      private String defaultTimeZone;
 6      @ApiModelProperty(value = "成功為1，失敗為0")
 7      private Integer result;
 8      @ApiModelProperty(value = "返回值資訊")
 9      private T data;
10      @ApiModelProperty(value = "返回給前端的語言，預設是：zh_CN")
11      private String lang;
12      @ApiModelProperty(value = "時間，預設是：Asia/Shanghai")
13      private String userTimeZone;
14  
15  
16      public ResponseVo(Integer result, T data) {
17          this(result, "Asia/Shanghai", "Asia/Shanghai", "zh_CN", data);
18      }
19  
20  
21      public ResponseVo(Integer result, String defaultTimeZone, String userTimeZone, String lang, T data) {
22          this.defaultTimeZone = defaultTimeZone;
23          this.result = result;
24          this.userTimeZone = userTimeZone;
25          this.lang = lang;
26          this.data = data;
27      }
28  
29      @Override
30      public String toString() {
31          return JSONObject.toJSONString(this);
32      }
33  }