swagger2的詳細筆記

2021-10-16 22:25:26 字數 1552 閱讀 5517

swagger2 是乙個規範和完整的框架,用於生成、描述、呼叫和視覺化restful風格的web服務。

介面文件對於前後端開發人員都非常重要。swagger可以使得介面文件動態生成

openapi:是rest api的api描述格式

open api規範可以使用yaml或json格式進行編寫。

open api規範為rest api定義了乙個與語言無關的標準介面。

swagger2的元件:

swagger ui:將open api規範呈現為互動式api文件,用視覺化ui展示描述檔案。

swagger codgen:將open api規範生成為伺服器存根和客戶端庫。

swagger hub:整合上面所有專案的各個功能。

spring fox:是根據**生成介面文件,所以生成進行更新專案版本,修改**即可,而不需要跟隨修改描述檔案。

>

>

io.springfoxgroupid

>

>

springfox-swagger2artifactid

>

>

2.9.2version

>

dependency

>

>

>

io.springfoxgroupid

>

>

springfox-swagger-uiartifactid

>

>

2.9.2version

>

dependency

>

在啟動類上新增乙個註解

@enableswagger2

//springfox的註解,開啟swagger2相關技術的開啟

//會掃瞄當前類所在的包以及子包中所有型別當中的註解。做swagger文件的定值

可以通過localhost:8080/swagger-ui.html來訪問swagger文件

swagger-ui可以幫我們做請求的模擬處理(類似於postman)

@configuration

public

class

swaggerconfig

}

自定義的註解類:

@target

(value =

)//描述當前的註解可以定義在什麼資源上面

//method:方法 type:型別 filed:屬性 parameter:定義在方法引數上

@retention

(retentionpolicy.runtime)

//當前註解什麼時候有效

//runtime:執行時有效 source:原始碼有效 class:位元組碼有效

public @inte***ce

myannotationswagger

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...