Springbootで使用されているSwagger2

1.Swaggerプロフィール：バックエンドの前の時代の分離、バックエンドコールフロントやバックエンドへのバックエンドの呼び出しのどちらかは、良好な界面のドキュメントを持っていることを期待し、標準化を提供する闊歩の出現は、この問題を解決します。

闊歩でSpringboot 2.：

　　（1）のpom.xml依存関係が追加されました：

1          < 依存性> 
2              < のgroupId > io.springfox </ groupIdを> 
3              < たartifactId > springfox-swagger2 </ たartifactId > 
4              < バージョン> 2.7.0 </ バージョン> 
5          </ 依存> 
6          < 依存性> 
7              < のgroupId > io.springfox </ groupIdを> 
8              < たartifactId >springfox-闊歩-UI</ たartifactId > 
9              < バージョン> 2.7.0 </ バージョン> 
10          </ 依存>

　　（2）は、このような名前のswaggerconfig.javaとして闊歩設定ファイルを確立します

1  パッケージcom.example.demo.config01。
2  
3  
4  インポートio.swagger.annotations.ApiOperation。
5  インポートorg.springframework.context.annotation.Bean。
6  インポートorg.springframework.context.annotation.Configuration。
7  インポートspringfox.documentation.builders.PathSelectors。
8  インポートspringfox.documentation.builders.RequestHandlerSelectors。
9  インポートspringfox.documentation.service.ApiInfo。
10  インポートspringfox.documentation.service.Contact。
11  インポートspringfox.documentation.spi.DocumentationType;
12  インポートspringfox.documentation.spring.web.plugins.Docket。
13  インポートspringfox.documentation.swagger2.annotations.EnableSwagger2。
14  
15  @Configuration
 16  EnableSwagger2 @
 17  パブリック クラスSwaggerConfig {
 18  
19      @Bean
 20      公衆整理applicationApi（）{
 21          リターン 新しいドケット（DocumentationType.SWAGGER_2）
 22                  .groupName（ "FAK" ）
 23                 .select（）のAPI（RequestHandlerSelectors.withMethodAnnotation（ApiOperation。。クラス））
 24                  .paths（PathSelectors.any（））ビルド（）。
 25                  .apiInfo（アプリケーション（））。
26      }
 27  
28      プライベートApiInfoアプリケーション（）{
 29          ApiInfo apiInfo = 新しい ApiInfo（ "接口管理"
 30                  、 "API接口说明"
 31                  、 "0.1"
 32                  ""
 33                  、新しい連絡先（ "zwill"、 ""、 " 」）
 34                  、
                 、 "" ）;
36          リターンapiInfo。
37      }
 38 }

　　（3）試験構成か

1  パッケージcom.example.demo.controller。
2  
3  インポートio.swagger.annotations.Api。
4  インポートio.swagger.annotations.ApiOperation。
5  インポートorg.springframework.web.bind.annotation.GetMapping。
6  インポートorg.springframework.web.bind.annotation.RestController。
7  
8 @Api（タグ= "サーバ" ）
 9  @RestController
 10  パブリック クラスServerController {
 11      @ApiOperation（値= "提供一个简单的对外接口" ）
 12      @GetMapping（ "/単にgetServer" ）
 13      公衆ストリングServerApi（）{
 14          リターン "ハロー" 。
15      }
 16 }

　　（4）結果は、（デフォルトのポート8080は、私がこのサイトを参照してくださいにhttp：// localhost：8080 /威張っ-ui.html）

　　テストすることができます！それを試してみてくださいクリックして、それは特に便利ではないでしょうか？

　　（5）いくつかの一般的な注釈swagger2

@Api（）
クラスのために、闊歩このクラスは、リソース識別される表現
tags-説明
付加価値が記載されているが、代替タグを使用することができる
複数のタグ値が存在する場合、しかし、リストを複数生成

@ApiOperation（） プロセスで使用される、HTTP要求操作が表す
方法を説明するために使用される値
コンテンツ促すノート
（該当使用）再編成することができるタグを
@ApiParam（） メソッドは、パラメータ、フィールドの説明で使用されると、パラメータを表しますメタデータ（説明、または必要な場合など）を追加します
名前名-パラメータ
値-パラメータの説明
に必要なrequired-

@ApiModel()用于类；表示对类进行说明，用于参数用实体类接收
value–表示对象名
description–描述
都可省略
@ApiModelProperty()用于方法，字段；表示对model属性的说明或者数据操作更改
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏

@ApiIgnore()用于类或者方法上，可以不被swagger显示在页面上
比较简单, 这里不做举例

@ApiImplicitParam() 用于方法
表示单独的请求参数
@ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam
name–参数ming
value–参数说明
dataType–数据类型
paramType–参数类型
example–举例说明

Springbootで使用されているSwagger2

おすすめ