spring boot 整合 swagger


git地址
https://github.com/a18792721831/studySpringCloud.git

1. swagger 簡介

Swagger,中文“拽”的意思,它是一個功能強大的在線 API文檔的框架,目前它的版本
爲2.x,所以稱爲 Swagger2。Swagger2提供了在線文檔的查閱和測試功能。利用 Swagger2很容易構建RESTful 風格的API,在Spring Boot 中集成 Swagger2。

2. 創建

在這裏插入圖片描述
引入依賴
implementation ‘io.springfox:springfox-swagger2:2.6.1’
implementation ‘io.springfox:springfox-swagger-ui:2.6.1’

3. 配置

在這裏插入圖片描述

4. 配置數據源

首先增加編碼集依賴
implementation ‘cn.easyproject:orai18n:12.1.0.2.0’
然後配置數據源
在這裏插入圖片描述

5. 枚舉

在這裏插入圖片描述

6. 枚舉映射

在這裏插入圖片描述

7. 實體

在這裏插入圖片描述

8. dao

在這裏插入圖片描述

9. service

在這裏插入圖片描述

10. controller

在這裏插入圖片描述

11. 配置日誌級別

logging:
  level:
    org:
      springframework:
        web:
          servlet:
            mvc:
              method:
                annotation:
                  RequestMappingHandlerMapping: trace

12. dao 測試

在這裏插入圖片描述

13. service測試

在這裏插入圖片描述

14. controller測試

在這裏插入圖片描述

15. swagger2註解

(3)寫生成文檔的註解
Swagger2通過註解來生成API接口文檔,文檔信息包括接口名、請求方法、參數、返回信息
等。通常情況下用於生成在線API文檔,以下的註解能夠滿足基本需求,註解及其描述如下。

  • @Api:修飾整個類,用於描述 Controller類。
  • @ApiOperation:描述類的方法,或者說一個接口。
  • @ApiParam:單個參數描述。
  • @ApiModel:用對象來接收參數。
  • @ApiProperty:用對象接收參數時,描述對象的一個字段。
  • @ApiResponse:HTTP響應的一個描述。
  • @ApiResponses:HTTP響應的整體描述。
  • @Apilgnore:使用該註解,表示Swagger2忽略這個API。
  • @ApiError:發生錯誤返回的信息。
  • @ApiParamImplicit:一個請求參數。
  • @ApiParamsImplicit:多個請求參數。

在這裏插入圖片描述
在這裏插入圖片描述

16. 啓動

在這裏插入圖片描述
在這裏插入圖片描述
在這裏插入圖片描述
在這裏插入圖片描述
在這裏插入圖片描述

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章