快捷導(dǎo)航

SpringBoot中使用Swagger的超簡(jiǎn)單方法

更新時(shí)間：2021年07月19日 10:10:09 作者：CV大魔王

大家一致認(rèn)為springBoot使用swagger太麻煩了，每次都需要編寫config，今天小編告訴大家一種超簡(jiǎn)單配置方法，教大家如何整合swagger，感興趣的朋友跟隨小編一起看看吧

Swagger號(hào)稱世界上最流行的Api框架,它是RestFul 風(fēng)格的Api。文檔在線自動(dòng)生成工具：Api文檔與API定義同步更新?？梢灾苯舆\(yùn)行，能在線測(cè)試API接口；支持多種編程語(yǔ)言：（Java、PHP等）。

官網(wǎng)：https://swagger.io/

springBoot使用swagger太麻煩，每次都需要編寫config？如果我告訴你有這么一種方式，你只需要配置yml文件，你學(xué)還是不學(xué)？

整合Swagger

依賴：

<!-- Swagger -->
<dependency>
    <groupId>com.battcn</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>2.1.5-RELEASE</version>
</dependency>

我這里的Swagger大家應(yīng)該也發(fā)現(xiàn)了，并非是官方的，這個(gè)是第三方整合的，配置更加簡(jiǎn)單。

配置詳解

詳細(xì)配置：

spring:
  swagger:
    enabled: true
    title: 標(biāo)題
    description: 描述信息
    version: 系統(tǒng)版本號(hào)
    contact:
      name: 維護(hù)者信息
    base-package: swagger掃描的基礎(chǔ)包，默認(rèn)：全掃描(分組情況下此處可不配置)
    #全局參數(shù),比如Token之類的驗(yàn)證信息可以全局話配置
    global-operation-parameters:
    -   description: 'Token信息,必填項(xiàng)'
        modelRef: 'string'
        name: 'Authorization'
        parameter-type: 'header'
        required: true
    groups:
      basic-group:
        base-package: com.battcn.controller.basic
      system-group:
        base-package: com.battcn.controller.system

我的配置

spring:
  swagger:
    title: 星空小屋 - 文章微服務(wù)接口
    description: 文章微服務(wù)相關(guān)接口，包括文章、模塊、知識(shí)點(diǎn)管理等
    version: 1.0.0 - SNAPSHOT
    contact:
      name: cv大魔王
      email: 1919301983@qq.com
    host: localhost
    enabled: true
    security:
      filter-plugin: true # 配置賬號(hào)密碼
      username: root
      password: root

配置攔截器，后面有攔截器配置，如果有讀者需要在自己的項(xiàng)目使用，請(qǐng)?jiān)械臄r截器配置中修改，忽略掉以下路徑，以免被攔截導(dǎo)致無(wú)法訪問(wèn)?！皊wagger-ui.html”, “static/css/", "static/js/”, “swagger-resources”, “/**/error”, “v2/api-docs”

測(cè)試使用

運(yùn)行項(xiàng)目，訪問(wèn)IP+端口號(hào)/swagger-ui.html，例如在瀏覽器訪問(wèn)：http://127.0.0.1:13001/swagger-ui.html

登錄后的效果：

復(fù)習(xí)——常用注解

對(duì)swagger熟悉的小伙伴的請(qǐng)忽略“常用注解段落”

`@Api`：用在 Controller 類上，描述該類的作用
  1. `value`="描述信息"
  2. `description`="詳細(xì)描述該類的作用"

@ApiOperation：用在 Controller 請(qǐng)求方法上，描述方法的作用。

@ApiModel：用在請(qǐng)求參數(shù)是對(duì)象上，描述該對(duì)象類的作用

// 在對(duì)象類上使用@ApiModel
@ApiModel(value="CategoryREQ對(duì)象", description="類別查詢條件")
public class CategoryREQ extends BaseRequest<Category> {
}

@ApiModelProperty：用在請(qǐng)求參數(shù)是對(duì)象的屬性上，描述對(duì)象屬性的作用。

value：屬性的描述
hidden：是否是查詢條件屬性, false:(默認(rèn)值)在api文檔顯示，作為查詢條件；true 隱藏，不是條件屬性

// 請(qǐng)求方法參數(shù)是 CategoryREQ 對(duì)象
public Result search(@RequestBody CategoryREQ req) {}

@ApiModel(value="CategoryREQ對(duì)象", description="類別查詢條件")
public class CategoryREQ extends BaseRequest<Category> {
    
    @ApiModelProperty(value = "分類名稱")
    private String name;

    @ApiModelProperty(value="狀態(tài)(1:正常，0:禁用)")
    private Integer status;
}

@ApiResponses：用在請(qǐng)求的方法上，用于表示一組響應(yīng)
@ApiResponse：用在 @ApiResponses 中，一般用于表達(dá)一個(gè)錯(cuò)誤的響應(yīng)信息，注解參數(shù)：
code：數(shù)字，如 400message：信息，如 “參數(shù)填寫錯(cuò)誤”response：拋出異常的類

@ApiIgnore: 使用該注解忽略這個(gè) API

@ApiImplicitParams：用在請(qǐng)求方法上，對(duì)多個(gè)請(qǐng)求參數(shù)增加描述

@ApiImplicitParam：可單獨(dú)使用，或在 @ApiImplicitParams 中使用，給方法的一個(gè)請(qǐng)求參數(shù)增加描述。

name：參數(shù)名
value：描述參數(shù)的作用
dataType：參數(shù)類型，參數(shù)類型，默認(rèn)String，其它值 dataType=“Integer”
defaultValue：參數(shù)默認(rèn)值
required：參數(shù)是否必傳（true/false）
paramTpye：指定參數(shù)放在哪些地方（header/query/path/body/form）

header ：參數(shù)在request headers 里邊提交 @RequestHeader
query ：直接跟參數(shù)完成自動(dòng)映射賦值 @RequestParam
path ：以路徑變量的形式提交數(shù)據(jù) @PathVariable
body ：以流的形式提交僅支持POST（不常用）
form ：以form表單的形式提交僅支持POST （不常用）
參考：

// 請(qǐng)求方法有多個(gè)請(qǐng)求參數(shù) size， current
@ApiImplicitParams({
    @ApiImplicitParam(name="current", value="頁(yè)碼", required=true, paramType="path",dataType="int"),
    @ApiImplicitParam(name="size", value="每頁(yè)記錄數(shù)", required=true, paramType="path",dataType="int")
})
@ApiOperation("根據(jù)分類名稱與狀態(tài)查詢分類列表接口")
@PostMapping("/search/{current}/{size}")
Result search(@RequestBody CategoryREQ req, @PathVariable int current, @PathVariable int size);

到此這篇關(guān)于SpringBoot中使用Swagger的超簡(jiǎn)單方法的文章就介紹到這了,更多相關(guān)SpringBoot使用Swagger內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: