@Api（）用於類

表示表示這個類是swagger的資源

Tags-表示說明

Value-也是說明，可以用tags替代

Demo:

@Api(value="使用者control"，tags={"使用者操作介面"})

@RestController

Public class Usercontroller{}

@APIOperation（）用於方法

表示一個http請求

value用於方法藐視

notes用於提示內容

tags可以重新分組（視情況而用）

@ApiParam（）用於方法，引數，欄位說明

表示對引數新增元資料（說明或是否必填等）

Name引數名

Value-canshushuomng

Required-是否必填

Demo:

@Api(value="使用者controller",tags={"使用者操作介面"}) @RestController public class UserController { @ApiOperation(value="獲取使用者資訊",tags={"獲取使用者資訊copy"},notes="注意問題點") @GetMapping("/getUserInfo") public User getUserInfo(@ApiParam(name="id",value="使用者id",required=true

@ApiModel( )用於類

表示對類進行說明，用於引數用實體類接收

Value-表示物件名

description-描述

都可省略

@APIModelProperty（） 用於方法，欄位

表示對model屬性的說明或者資料操作更改

Value-欄位說明

Name-重寫屬性名字

dataType-重寫屬性型別

required-是否必填

Example-舉例說明

Hidden-隱藏

@Apilgnore()用於類，方法，方法引數

表示這個方法或者類被忽略

@ApilmplicitParam（）用於方法

1. name ：引數名。 

2. value ： 引數的具體意義，作用。 

3. required ： 引數是否必填。 

4. dataType ：引數的資料型別。 

5. paramType ：查詢引數型別，這裡有幾種形式：

表示單獨的請求引數

@ApilmplicitParams()用於方法，包含多個@ ApilmplicitParam

Name-引數名

value-引數說明

datatype-資料型別

paramType-引數型別

Example-舉例說明

Demo

@ApiOperation("查詢測試") @GetMapping("select") //@ApiImplicitParam(name="name",value="使用者名稱",dataType="String", paramType = "query") @ApiImplicitParams({ @ApiImplicitParam(name="name",value="使用者名稱",dataType="string", paramType = "query",example="xingguo"), @ApiImplicitParam(name="id",value="使用者id",dataType="long", paramType = "query")}) public void select(){ }