SpringBoot で Swagger を使用する方法

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

#ログイン後の効果:

##レビュー - よく使用される注釈

Swagger に詳しい人は、「一般的な注釈の段落」を無視してください。

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

@ApiOperation

: 説明するためにコントローラーのリクエスト メソッドで使用されます。メソッドの機能。

@ApiModel

: リクエスト パラメーターがオブジェクトの場合に使用され、オブジェクト クラスの役割を記述します。 <div class="code" style="position:relative; padding:0px; margin:0px;"><pre class='brush:php;toolbar:false;'>// 在对象类上使用@ApiModel @ApiModel(value=&quot;CategoryREQ对象&quot;, description=&quot;类别查询条件&quot;) public class CategoryREQ extends BaseRequest&lt;Category&gt; { }</pre><div class="contentsignin">ログイン後にコピー</div></div>

@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
: 番号 (例: 400
• message

  : メッセージ (例)) 「パラメータ入力エラー」 応答: 例外をスローしたクラス##@ApiIgnore

  : この API
# を無視するには、このアノテーションを使用します

##@ApiImplicitParams

: 複数のリクエスト パラメーターに説明を追加するためにリクエスト メソッドで使用されます

@ApiImplicitParam

: 単独で使用することも、@ApiImplicitParams 内で使用して 1 つのリクエスト パラメーターに説明を追加することもできますメソッドのリクエストパラメータ。

#name：パラメータ名

1. value：パラメータの機能を説明します

2. ##dataType

   : パラメータのタイプ、パラメータのタイプ、デフォルトの文字列、その他の値 dataType="Integer"

## defaultValue
3. : パラメータのデフォルト値

required
4. : パラメータを渡す必要があるかどうか (true/false)

paramTpye
5. : パラメーターが配置される場所を指定します (ヘッダー/クエリ/パス/ボディ/フォーム)

header
6. : パラメーターが送信されますリクエストヘッダー内 @RequestHeader

   query: パラメータを使用して自動マッピングと割り当てを直接完了 @RequestParam

path

: パス変数の形式でデータを送信 @PathVariable

body: ストリーム形式での送信は POST のみをサポートします (一般的に使用されません)
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 中国語 Web サイトの他の関連記事を参照してください。