7.3.2闊歩コメント

オリジナルリンクします。https：//blog.csdn.net/u014231523/article/details/76522486

注：
1.バージョンは、ここで使用：springfox-swagger2を（2.4）springfox-闊歩-UI（2.4）
ここで2は、共通のメモや（統合を完了した闊歩に言うことです）基本的な使い方の意味を説明する
、統合されていませんしてください参照
SpringBoot構造物統合springfox-swagger2安らかAPI
SPRINGMVC構文統合springfox-swagger2安らかAPI
公式サイトのWIKIの
共通アノテーションを：
- @Apiを（）クラスのために、
このクラスは、リソース闊歩識別さを表す
- @ApiOperation（）工程で使用する。
表わしHTTP操作要求
- @ApiParam（）メソッドは、パラメータ、フィールドの説明で使用されると、
メタデータパラメータ（必要な命令等の場合）添加表す
- @ApiModelを（）クラスと、
クラスを説明表し、パラメータは受信エンティティ・クラス
- @ApiModelProperty（）プロセスで使用される、フィールド
モデル属性に操作指示やデータの変更を示す
- @ApiIgnore（）クラス、メソッド、メソッドパラメータに対して
このメソッドまたはクラスが無視されることを示している
- @ApiImplicitParam（）メソッドで使用する
別の要求パラメータを表し
- @ApiImplicitParams（）プロセスで使用されるが、複数の@ApiImplicitParamを含みます

具体的に例示使用：
@Api（）
クラスに対して、このクラスを表す闊歩は、リソースを特定する
tags-説明
付加価値説明、代替タグを使用することができるされている
リストの複数のタグ値がある場合は、しかし、生成した複数

@Api（値= "ユーザコントローラ"、タグ= { "ユーザインタフェースの操作" }）
@RestController 
パブリック クラスUserControllerで{ 

}

レンダリング：

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

@Api（値=「ユーザコントローラ」、タグ= {「ユーザインタフェースの操作」}）
@RestController 
パブリック クラスUserControllerで{ 
     @ApiOperation（値 =「ユーザ情報取得」、タグ= {「ユーザ情報コピー」}、ノート= "注目の問題" ）
     @GetMapping（ "/ getUserInfo" ）
      公共ユーザーgetUserInfo（@ApiParam（名前= "言及ID以上"、値= "ユーザー上記ID以上"、必要= trueに）ロング上記ID、@ ApiParam（名前= "ユーザ名"上で、値=「ユーザ名」）文字列名）{
      // UserServiceのは無視できる、ビジネスロジックであることを 
      ユーザユーザー= userService.getUserInfo（）; 

      戻りユーザ; 
  } 
}

レンダリング：

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

@ApiModel(value="user对象",description="用户对象user")
public class User implements Serializable{
    private static final long serialVersionUID = 1L;
     @ApiModelProperty(value="用户名",name="username",example="xingguo")
     private String username;
     @ApiModelProperty(value="状态",name="state",required=true)
      private Integer state;
      private String password;
      private String nickName;
      private Integer isDeleted;

      @ApiModelProperty(value="id数组",hidden=true)
      private String[] ids;
      private List<String> idList;
     //省略get/set
}

 @ApiOperation("更改用户信息")
  @PostMapping("/updateUserInfo")
  public int updateUserInfo(@RequestBody @ApiParam(name="用户对象",value="传入json格式",required=true) User user){

     int num = userService.updateUserInfo(user);
     return num;
  }

效果图：

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

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

  @ApiOperation（ "查询测试" ）
  （@GetMapping "選択" ）
   // @ApiImplicitParam（名= "名前"、値= "用户名"、DataTypeが"文字列"、paramType = "クエリ"）
  @ApiImplicitParams（{ 
  @ ApiImplicitParam（名 = "名前"、値= "用户名"、DataTypeが"文字列"、paramType = "クエリ"、例えば= "興国" ）、
  @ApiImplicitParam（名 = "ID"、値= "用户ID"、 DataTypeが"長い"、paramType = "クエリ" ）}）
   公共 ボイド（選択）{ 

  }

レンダリング：