swagger2配置詳解

2022-08-22 23:27:16 字數 2034 閱讀 6962

**

@api(tags = "使用者相關介面", description = "提供使用者相關的 rest api")

public class usercontroller

屬性解析

註解屬性

型別描述

br#控制器標籤。

description

string

控制器描述 (該字段被申明為過期)

@apioperation 主要屬性

** @apioperation(value = "登入介面",notes = "登入介面",httpmethod = "post",responsecontainer="登入成功,登入失敗")

屬性解析

註解屬性

型別描述

value

string

介面說明。

notes

string

介面發布說明。

br#標籤。response

class<?>

介面返回型別。

介面請求方式。

@apiignore

swagger 文件不會顯示擁有該註解的介面

@apiimplicitparams

用於描述介面的非物件引數集

@apiimplicitparam

用於描述介面的非物件引數,一般與 @apiimplicitparams 組合使用。

@apiimplicitparam

**示例

@apiimplicitparams()

public resultmsgbean> queryformenulistbyaccountid()

主要屬性

註解屬性

描述paramtype

查詢引數型別,實際上就是引數放在那裡。取值:

path:以位址的形式提交資料,根據 id查詢使用者的介面就是這種形式傳參。

query:query string 的方式傳參。

header:以流的形式提交。

form:以 form 表單的形式提交。

datatype

引數的資料型別。取值:long string

name

引數名字。

value

引數意義的描述。

required

是否必填。取值:true:必填引數。false:非必填引數。

@apimodel:

可設定介面相關實體的描述。

@apimodelproperty:

可設定實體屬性的相關描述

@apimodel(description= "賬戶資訊類")

public class systemaccountbean extends customerpersonbean

註解屬性

型別描述

value

string

字段說明。

name

string

重寫字段名稱。

datatype

stirng

重寫字段型別。

required

boolean

是否必填。

example

stirng

舉例說明。

hidden

boolean

是否在文件中隱藏該欄位。

allowemptyvalue

boolean

是否允許為空。

allowablevalues

string

該欄位允許的值,當我們 api 的某個引數為列舉型別時,

使用這個屬性就可以清楚地告訴 api 使用者該引數所能允許傳入的值。

springboot搭建swagger2超簡單

必須使用以下配置開啟swagger服務 enableswagger2 configuration enableswagger2 public class swaggerconfig implements webmvcconfigurer private apiinfo apiinfo api tag...

Swagger2使用記錄

configuration public class swagger2 private apiinfo apiinfo enableswagger2 public static void main string args io.springfox springfox swagger2 2.9.2 i...

SpringBoot整合swagger2 詳細

前言 前段時間自己單建了個springboot小demo 然後準備加入相關的條條框框,我們今天來看下我們整合swagger,保留下筆記以後方便自己檢視。之前寫的ssm整合swagger 連線 ssm整合swagger位址 使用swagger,就是把相關的資訊儲存在它定義的描述檔案裡面 yml或jso...