SpringBoot中使用怎麼Swagger-java教程-PHP中文網

SpringBoot中使用怎麼Swagger

WBOY

發布： 2023-05-17 20:16:10

轉載

1641 人瀏覽過

整合Swagger

依賴：

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

登入後複製

我這裡的Swagger大家應該也發現了，並非是官方的，這個是第三方整合的，設定更加簡單。

配置詳解

詳細配置：

spring:
  swagger:
    enabled: true
    title: 标题
    description: 描述信息
    version: 系统版本号
    contact:
      name: 维护者信息
    base-package: swagger扫描的基础包，默认：全扫描(分组情况下此处可不配置)
    #全局参数,比如Token之类的验证信息可以全局话配置
    global-operation-parameters:
    -   description: "Token信息,必填项"
        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: 星空小屋 - 文章微服务接口
    description: 文章微服务相关接口，包括文章、模块、知识点管理等
    version: 1.0.0 - SNAPSHOT
    contact:
      name: cv大魔王
      email: 1919301983@qq.com
    host: localhost
    enabled: true
    security:
      filter-plugin: true # 配置账号密码
      username: root
      password: root

登入後複製

配置攔截器，後面有攔截器配置，如果有讀者需要在自己的項目使用，請原有的攔截器配置中修改，忽略掉以下路徑，以免被攔截導致無法存取。 “swagger-ui.html”, “static/css/", "static/js/”, “swagger-resources”, “/**/error”, “v2/api-docs”

測試使用

運行項目，存取IP 連接埠號碼/swagger-ui.html，例如在瀏覽器存取：http://127.0.0.1:13001/swagger -ui.html

SpringBoot中使用怎麼Swagger

登入後的效果：

SpringBoot中使用怎麼Swagger

複習――常用註解

對swagger熟悉的小夥伴的請忽略「常用註解段落」

`@Api`：用在 Controller 类上，描述该类的作用
  1. `value`="描述信息"
  2. `description`="详细描述该类的作用"

登入後複製

@ApiOperation：用在Controller 請求方法上，描述方法的作用。

@ApiModel：用在請求參數是物件上，描述該物件類別的作用

// 在对象类上使用@ApiModel
@ApiModel(value="CategoryREQ对象", description="类别查询条件")
public class CategoryREQ extends BaseRequest<Category> {
}

登入後複製

@ApiModelProperty：用在請求參數是物件的屬性上，描述物件屬性的作用。

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

// 请求方法参数是 CategoryREQ 对象
public Result search(@RequestBody CategoryREQ req) {}

@ApiModel(value="CategoryREQ对象", description="类别查询条件")
public class CategoryREQ extends BaseRequest<Category> {
    
    @ApiModelProperty(value = "分类名称")
    private String name;

    @ApiModelProperty(value="状态(1:正常，0:禁用)")
    private Integer status;
}

登入後複製

@ApiResponses：用在在請求的方法上，用來表示一組回應
@ApiResponse：用在 @ApiResponses 中，一般用來表示一個錯誤的回應訊息，註解參數：
code：數字，如400message：訊息，如「參數填寫錯誤」 response：拋出異常的類別

@ApiIgnore: 使用該註解忽略這個API

@ApiImplicitParams：用在請求方法上，對多個請求參數增加描述

@ApiImplicitParam：可單獨使用，或在@ApiImplicitParams 中使用，為方法的一個請求參數增加描述。

name：參數名稱
#value：描述參數的功能
dataType：參數類型，參數類型，預設String，其它值dataType=“Integer”
defaultValue：參數預設值
required：參數是否必傳（true/false）
paramTpye ：指定參數放在哪些地方（header/query/path/body/form）

header ：參數在request headers 裡邊提交@RequestHeader
query ：直接跟參數完成自動對映賦值@RequestParam
path ：以路徑變數的形式提交資料@PathVariable
body ：以流的形式提交僅支援POST（不常用）
form ：以form表單的形式提交僅支援POST （不常用）
參考：

// 请求方法有多个请求参数 size， current
@ApiImplicitParams({
    @ApiImplicitParam(name="current", value="页码", required=true, paramType="path",dataType="int"),
    @ApiImplicitParam(name="size", value="每页记录数", required=true, paramType="path",dataType="int")
})
@ApiOperation("根据分类名称与状态查询分类列表接口")
@PostMapping("/search/{current}/{size}")
Result search(@RequestBody CategoryREQ req, @PathVariable int current, @PathVariable int size);

登入後複製

以上是SpringBoot中使用怎麼Swagger的詳細內容。更多資訊請關注PHP中文網其他相關文章！