Spring Boot怎樣集成Swagger-UI

本篇文章為大家展示了Spring Boot怎樣集成Swagger-UI，內容簡明扼要并且容易理解，絕對能使你眼前一亮，通過這篇文章的詳細介紹希望你能有所收獲。

Swagger-UI

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

一、Swagger-UI簡介

    Swagger是一個Restful風格接口的文檔在線自動生成和測試的框架
    官網對Swagger-UI的介紹：
     簡單的說就是：Swagger提供了一組靜態頁面，可以在SpringBoot應用中集成這些靜態頁面，直接訪問靜態頁面，并打開指定的Swagger規范，就可以顯示、測試調用接口：
    而在SpringBoot中集成Swagger是非常容易的，僅需增加幾個簡單的注解。
    效果如圖：

二、pom 依賴

三、pom 配置Swagger2Config類

    Swagger2Config類位于config包，用來配置swagger。
    介紹一些簡單的配置：

API接口文檔的生成范圍

    Swagger對生成API文檔的范圍有三種不同的選擇
    生成指定包面的類的API文檔下
    生成有指定注解的類的API文檔
    生成有指定注解的方法的API文檔
    三種方式如圖： 

配置頁面信息

    對應關系如圖  

四、給交易類配置注解

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

@Api

     value - 字段說明
    description - 注釋說明這個類
    對應：

@ApiOperation

    value - 字段說明
    notes - 注釋說明
    httpMethod - 說明這個方法被請求的方式
    response - 方法的返回值的類型

@ApiModelProperty

    value–字段說明
    name–重寫屬性名字
    dataType–重寫屬性類型
    required–是否必填
    example–舉例說明
    hidden–隱藏
 

@ApiResponse

    code - 響應的HTTP狀態碼
    message - 響應的信息內容

五、authorizations

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

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

六、文檔調用

    http://localhost:8080/swagger-ui.html
     看版本信息
    http://localhost:8080/swagger-resources/

上述內容就是Spring Boot怎樣集成Swagger-UI，你們學到知識或技能了嗎？如果還想學到更多技能或者豐富自己的知識儲備，歡迎關注億速云行業資訊頻道。