SwaggerAPI註解詳解

2021-10-07 21:53:18 字數 1782 閱讀 8628

註解

@api:

作用在類上,用來標註該類具體實現內容。表示標識這個類是swagger的資源 。

引數:tags:可以使用tags()允許您為操作設定多個標籤的屬性,而不是使用該屬性。

description:可描述描述該類作用。

@apiimplicitparam:

作用在方法上,表示單獨的請求引數

引數:name :引數名。

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

required : 引數是否必填。

datatype :引數的資料型別。

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

型別 作用

path 以位址的形式提交資料

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

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

header 引數在request headers 裡邊提交

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

在這裡我被坑過一次:當我發post請求的時候,當時接受的整個引數,不論我用body還是query,後台都會報body missing錯誤。這個引數和springmvc中的@requestbody衝突,索性我就去掉了paramtype,對介面測試並沒有影響。

@apiimplicitparams:

用於方法,包含多個 @apiimplicitparam:

例:@apiimplicitparams()

@apimodel:

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

@apimodelproperty:

用於方法,字段 ,表示對model屬性的說明或者資料操作更改

例:

@apimodel(value = "user", description = "使用者")

public class user implements serializable", groups = )

protected string id;

/** * code/登入帳號

*/@apimodelproperty(value = "code/登入帳號")

@notempty(message = "", groups = )

protected string itcode;

/** * 使用者姓名

*/@apimodelproperty(value = "使用者姓名")

@notempty(message = "", groups = )

protected string name;

@apioperation:

用於方法,表示乙個http請求的操作 。

@apiimplicitparams()

@responsebody

public book getbook(@pathvariable long id, string date)

@apiresponse:

用於方法,描述操作的可能響應。

@apiresponses:

用於方法,乙個允許多個apiresponse物件列表的包裝器。

例:@apiresponses(value = )

@apiparam:

用於方法,引數,字段說明,表示對引數的新增元資料(說明或是否必填等)

@authorization:

宣告要在資源或操作上使用的授權方案。

@authorizationscope:

介紹乙個oauth2授權範圍。

@responseheader:

響應頭設定,使用方法。

SwaggerAPI註解詳解,以及註解常用引數配置

作用在類上,用來標註該類具體實現內容。表示標識這個類是swagger的資源 引數 1.tags 可以使用tags 允許您為操作設定多個標籤的屬性,而不是使用該屬性。2.description 可描述描述該類作用。作用在方法上,表示單獨的請求引數 引數 1.name 引數名。2.value 引數的具體...

Swagger API管理,漢化

用於類 表示標識這個類是swagger的資源 tags 表示說明 value 也是說明,可以使用tags替代 但是tags如果有多個值,會生成多個list controller api value 使用者controller tags public class webcontroller apiop...

swaggerAPI介面文件分組

swagger是乙個深度整合的後台api文件工具,極大的方便了後端的開發測試以及和前端的對接工作。但是當專案中的介面越來越多時,會導致頁面上的介面過多,檢視起來不是很方便,這時可以使用swagger的分組功能將介面進行分組分頁展示。分組的規則可以基於路徑和註解等,下面主要介紹下基於註解的分類,這種方...