Swagger 常用註解說明

2021-08-28 09:13:32 字數 1867 閱讀 2763

@api()用於類

表示表示這個類是swagger的資源

tags-表示說明

value-也是說明,可以用tags替代

demo:

@api(value="使用者control",tags=)

@restcontroller

public class usercontroller{}

@apioperation()用於方法

表示乙個http請求

value用於方法藐視

notes用於提示內容

tags可以重新分組(視情況而用)

@apiparam()用於方法,引數,字段說明

表示對引數新增元資料(說明或是否必填等)

name引數名

value-canshushuomng

required-是否必填

demo:

@api(value="

使用者controller",tags=) @restcontroller public class usercontroller ,notes="

注意問題點

使用者id",required=true) long id,@apiparam(name="username",value="

使用者名稱") string username) }

@apimodel( )用於類

表示對類進行說明,用於引數用實體類接收

value-表示物件名

description-描述

都可省略

@apimodelproperty() 用於方法,字段

表示對model屬性的說明或者資料操作更改

value-欄位說明

name-重寫屬性名字

datatype-重寫屬性型別

required-是否必填

example-舉例說明

hidden-隱藏

@apilgnore()用於類,方法,方法引數

表示這個方法或者類被忽略

@apilmplicitparam()用於方法

1. name :引數名。 

2. value : 引數的具體意義,作用。 

3. required : 引數是否必填。 

4. datatype :引數的資料型別。 

5. paramtype :查詢引數型別,這裡有幾種形式:

型別

作用

path

以位址的形式提交資料

query

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

body

以流的形式提交 僅支援post

header

引數在request headers 裡邊提交

form

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

表示單獨的請求引數

@apilmplicitparams()用於方法,包含多個@ apilmplicitparam

name-引數名

value-引數說明

datatype-資料型別

paramtype-引數型別

example-舉例說明

demo

@apioperation("

查詢測試")@

"select"

)//@

apiimplicitparam(name=

"name"

,value=

"使用者名稱

",datatype=

"string"

, paramtype =

"query")@

apiimplicitparams()

public void

select()

swagger註解說明 swagger常用註解說明

常用到的註解有 apiapimodel apimodelproperty apioperation apiparam apiresponse apiresponses responseheader 1.api標記 api 用在類上,說明該類的作用。可以標記乙個controller類做為swagger...

swagger常用註解說明

作者 xiangdong she 作者連線 常用到的註解有 api標記 api 標記可以標記乙個controller類做為swagger 文件資源,使用方式 api value user description operations about user 與controller註解並列使用。屬性配置...

swagger常用註解說明

常用到的註解有 1.api標記 api 用在類上,說明該類的作用。可以標記乙個controller類做為swagger 文件資源,使用方式 api value user description operations about user 與controller註解並列使用。屬性配置 屬性名稱 備註v...