swagger 注解文檔

1. @Api()

作用于類，放置于 controller 的一個類上，標志這個類是 swagger 資源

1.1 參數：

1.2 實例代碼：

@Api(value = "swagger2測試api", tags = "管理員")
@RequestMapping("/api/admin")
public interface AdminFeign {
  
}

1.3 示例圖：

2. @ApiOperation()

作用于方法之上，用戶表示一個 http 的請求

2.1 參數

2.2 示例代碼

@ApiOperation(value = "添加管理員", notes = "查詢數據庫中某個的學生信息")
@RequestMapping(value = "/", method = RequestMethod.POST)
Admin post(Admin admin);

2.3 示例圖

3. @ApiParam()

作用于方法，用于參數字段的說明

3.1 參數

3.2 示例代碼

@ApiOperation(value = "刪除管理員", notes = "刪除數據庫中某個的學生信息")
@RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
Admin delete(@ApiParam(name = "id", value = "管理員id", required = true)@PathVariable("id") String id);

3.3 示例圖

4. @ApiModel()

作用于類，對類進行說明，用于實體類接收或者返回

4.1 參數

4.2 代碼演示

@Data
@ApiModel("管理員")
public class Admin {
    /**
     * 管理員id
     */
    @ApiModelProperty(value = "管理員id")
    private String id;
    /**
     * 管理員姓名
     */
    @ApiModelProperty(value = "管理員姓名")
    private String name;
}

4.3 示例圖

5. @ApiModelProperty()

作用于實體類，用于實體類中某個字段

5.1 參數

5.2 示例代碼

@Data
@ApiModel("管理員")
public class Admin {
    /**
     * 管理員id
     */
    @ApiModelProperty(value = "管理員id", name = "id", required = true)
    private String id;
    /**
     * 管理員姓名
     */
    @ApiModelProperty(value = "管理員姓名", name = "name", required = true)
    private String name;
}

5.3 示例圖

6. @ApiImplicitParams()

作用于方法之上，解釋請求參數里邊添加@ApiImplicitParam()注解

6.1 參數

6.2 示例代碼

 @ApiOperation(value = "刪除管理員", notes = "刪除數據庫中某個的學生信息")
 @ApiImplicitParams({
        @ApiImplicitParam(name = "id", value = "管理員ID", paramType = "path", required = true)
    })
 @RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
 Admin delete(@PathVariable("id") String id);

6.3 示例圖片