SpringBoot新增Swagger配置

2021-08-25 14:01:17 字數 1455 閱讀 5032

swagger 是乙個規範和完整的框架,用於生成、描述、呼叫和視覺化 restful 風格的 web 服務。 總體目標是使客戶端和檔案系統作為伺服器以同樣的速度來更新。 檔案的方法/引數/模型緊密整合到伺服器端的**,允許api來始終保持同步。swagger 讓部署管理和使用功能強大的api從未如此簡單。

1,先在pom.xml檔案裡面加入依賴

io.springfox

springfox-swagger2

2.6.1

io.springfox

springfox-swagger-ui

2.6.1

2,編寫controller,這邊我的包路徑是com.example.yuanx.controller

/**

* created by 快樂風男 on 2018/8/23.

*/@api(value = "kuaile")

@restcontroller

public class testcontroller

}

3,編寫configuration,這邊我的包路徑是com.example.yuanx.swagger

/**

* swagger配置類.

*/@enableswagger2 // swagger的開關,表示已經啟用swagger

@configuration // 宣告當前配置類

public class swaggerconfiguration ")

private string basepackage; // controller介面所在的包

@value("$")

private string title; // 當前文件的標題

@value("$")

private string description; // 當前文件的詳細描述

@value("$")

private string version; // 當前文件的版本

@bean

public docket createrestapi()

private apiinfo apiinfo()

}

4,配置properties檔案

#配置

server.port=8090

# 配置swagger

swagger.basepackage: com.example.yuanx.controller

swagger.title: 快樂風男のapi

swagger.description: 死亡如風常伴吾身

swagger.version: v1.0

SpringBoot如何優雅地使用Swagger2

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

SpringBoot開發案例之整合Swagger篇

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

SpringBoot開發案例之整合Swagger篇

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