本文介紹如何用spring boot集成Swagger-UI，實現項目在線接口文檔

一、Swagger-UI簡介

Swagger是一個Restful風格接口的文檔在線自動生成和測試的框架

官網對Swagger-UI的介紹：

簡單的說就是：Swagger提供了一組靜態頁面，可以在SpringBoot應用中集成這些靜態頁面，直接訪問靜態頁面，并打開指定的Swagger規范，就可以顯示、測試調用接口：

而在SpringBoot中集成Swagger是非常容易的，僅需增加幾個簡單的注解。

效果如圖：

二、在pom.xml中引入Swagger-UI相關依賴

三、如何配置Swagger2Config類

Swagger2Config類位于config包，用來配置swagger。

介紹一些簡單的配置：

1、API接口文檔的生成范圍，即在頁面顯示你哪些API接口

Swagger對生成API文檔的范圍有三種不同的選擇

• 生成指定包面的類的API文檔下
• 生成有指定注解的類的API文檔
• 生成有指定注解的方法的API文檔

三種方式如圖：

2、配置頁面信息

對應關系如圖:

三、如何給交易類配置注解

常用注解

• @Api：用于修飾Controller類，生成Controller相關文檔信息
• @ApiOperation：用于修飾Controller類中的方法，生成接口方法相關文檔信息
• @ApiParam：用于修飾接口中的參數，生成接口參數相關文檔信息
• @ApiModelProperty：用于修飾實體類的屬性，當實體類是請求參數或返回結果時，直接生成相關文檔信息

1、@Api

value - 字段說明

description - 注釋說明這個類

對應：

2、@ApiOperation

value - 字段說明

notes - 注釋說明

httpMethod - 說明這個方法被請求的方式

response - 方法的返回值的類型

3、@ApiModelProperty

value–字段說明

name–重寫屬性名字

dataType–重寫屬性類型

required–是否必填

example–舉例說明

hidden–隱藏

4、@ApiResponse

code - 響應的HTTP狀態碼

message - 響應的信息內容

四、如何加authorizations

如項目集成了OAuth2或JWT等 用戶驗證，不能直接調用需要添加 authorizations

可以從控制臺拿到，添加后就可以自由調用

五、文檔調用

http://localhost:8080/swagger-ui.html

看版本信息

http://localhost:8080/swagger-resources/

總結

以上是生活随笔為你收集整理的idea swagger生成接口文档_spring boot集成Swagger-UI接口文档的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。