SpringBoot整合swagger2 詳細

2021-10-02 02:31:31 字數 1681 閱讀 9239

前言:

前段時間自己單建了個springboot小demo 然後準備加入相關的條條框框,我們今天來看下我們整合swagger,保留下筆記以後方便自己檢視。

之前寫的ssm整合swagger 連線:ssm整合swagger位址

使用swagger,就是把相關的資訊儲存在它定義的描述檔案裡面(yml或json格式),再通過維護這個描述檔案可以去更新介面文件,以及生成各端**。而springfox-swagger,則可以通過掃瞄**去生成這個描述檔案,連描述檔案都不需要再去維護了。所有的資訊,都在**裡面了。**即介面文件,介面文件即**。

io.springfox<

/groupid>

springfox-swagger2<

/artifactid>

2.7.0

<

/version>

<

/dependency>

io.springfox<

/groupid>

springfox-swagger-ui<

/artifactid>

2.7.0

<

/version>

<

/dependency>

/**

* @description: swagger congfig 配置類

* @author: xxk

* @date: 2019/12/9 19:45

* @modifieddate:

*/@configuration

@enableswagger2

public

class

swaggerconfig

implements

environmentaware

@bean

public docket swaggerspringfoxdocket()

ms", watch.

gettotaltimemillis()

);return swaggerspringmvcplugin;

}private apiinfo apiinfo()

private apikey apikey()

private securitycontext securitycontext()

list

defaultauth()

));}

}

常用註解:

示例

@api

(tags =

)@restcontroller

("/api/v1/testdemo"

)public

class

democontroller

@apioperation

(value =

"查詢天氣工具"

(value =

"/queryweather"

,method = requestmethod.get)

public

void

queryweather()

}

記錄問題.提高自己.保護頭髮.從我做起。

SpringBoot開發案例之整合Swagger篇

前段時間整合過的乙個支付服務,由於使用了spring boot快速開發,但是又懶得寫詳細的文件介紹,便順手就把swagger整合進來了,對支付服務進行分組api展示,如上圖。我有幾張阿里雲幸運券分享給你,用券購買或者公升級阿里雲相應產品會有特惠驚喜哦!把想要買的產品的幸運券都領走吧!快下手,馬上就要...

SpringBoot開發案例之整合Swagger篇

前段時間整合過的乙個支付服務,由於使用了spring boot快速開發,但是又懶得寫詳細的文件介紹,便順手就把swagger整合進來了,對支付服務進行分組api展示,如上圖。swagger 是乙個規範和完整的框架,用於生成 描述 呼叫和視覺化 restful 風格的 web 服務。總體目標是使客戶端...

SpringBoot如何優雅地使用Swagger2

spring boot 框架是目前非常流行的微服務框架,我們很多情況下使用它來提供 rest api。而對於 rest api 來說很重要的一部分內容就是文件,swagger 為我們提供了一套通過 和註解自動生成文件的方法,這一點對於保證 api 文件的及時性將有很大的幫助。本文將使用 swagge...