Swagger常用註解

2022-06-18 03:30:15 字數 892 閱讀 7877

swagger註解:

@api:  修飾整個類,描述controller的作用

@apioperation:  描述乙個類的乙個方法,或者說乙個介面

@apiparam:  單個引數描述

@apimodel:  用物件來接收引數

@apimodelproperty:  用物件接收引數時,描述物件的乙個字段

@apiresponse:  http響應其中1個描述

@apiresponses:  http響應整體描述

@apiignore:  使用該註解忽略這個api

@apierror :  發生錯誤返回的資訊

@apiimplicitparam:  乙個請求引數

@apiimplicitparams:  多個請求引數

@apiimplicitparam屬性:

屬性      取值      作用

paramtype       查詢引數型別

path      以位址的形式提交資料

query       直接跟引數完成自動對映賦值

body      以流的形式提交 僅支援post

header     引數在request headers 裡邊提交

form       以form表單的形式提交 僅支援post

datatype        引數的資料型別 只作為標誌說明,並沒有實際驗證

long

string

name        接收引數名

value        接收引數的意義描述

required        引數是否必填

true      必填

false     非必填

defaultvalue      預設值

swagger常用註解

一 swagger常用註解 1 與模型相關的註解 兩個註解 2 與介面相關的註解 六個註解 二 幾個注意點 為了在swagger ui上看到輸出,至少需要兩個註解 api和 apioperation 即使只有乙個 apiresponse,也需要使用 apiresponses包住 對於 apiimpl...

swagger常用註解

一 swagger常用註解 1 與模型相關的註解 兩個註解 2 與介面相關的註解 六個註解 二 幾個注意點 為了在swagger ui上看到輸出,至少需要兩個註解 api和 apioperation 即使只有乙個 apiresponse,也需要使用 apiresponses包住 對於 apiimpl...

swagger常用註解

swagger2常用註解說明 2017年08月01日 14 00 38 說明 1.這裡使用的版本 springfox swagger2 2.4 springfox swagger ui 2.4 2.這裡是說明常用註解的含義和基本用法 也就是說已經對swagger進行整合完成 沒有整合的請參見 spr...