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

2021-08-28 13:13:59 字數 1606 閱讀 8309

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

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

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

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

引數:1. name :引數名。

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

3. required : 引數是否必填。

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

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

型別作用

path

以位址的形式提交資料

query

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

body

以流的形式提交 僅支援post

header

引數在request headers 裡邊提交

form

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

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

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

例:

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

用於方法,字段 ,表示對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;

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

@apiimplicitparams()

@responsebody

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

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

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

例:

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

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

介紹乙個oauth2授權範圍。

響應頭設定,使用方法。

SwaggerAPI註解詳解

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

Jersey註解詳解

rest 中最重要的概念是資源 resources 使用全球 id 通常使用 uri 標識。客戶端應用程式使用 http 方法 get post put delete 操作資源或資源集。restful web 服務是使用 http 和 rest 原理實現的web 服務。通常,restful web ...

Spring 註解詳解

使用註解來構造ioc容器 在base package指明乙個包 表明com.om包及其子包中,如果某個類的頭上帶有特定的註解 component repository service controller 就會將這個物件作為bean註冊進spring容器。1 component component是...