swagger 注释

来源：互联网发布：高德端口修改器 v33 编辑：程序博客网时间：2024/06/05 14:24

①类名上用@Api(description = "能力相关API") 注解

@RestController@RequestMapping("/api")@Api(description = "能力相关API")public class CompetencyClientResource

②方法上用@ApiOperation("能力删除")注解（@ApiParam 是对competencyId的注释）

@ApiOperation("能力删除")@PostMapping("/competency/delete/{competencyId}")@Timedpublic ResponseEntity<String> deleteCompetency(@ApiParam("能力ID") @PathVariable Long competencyId)

③在model上的注解用 @ApiModel

@ApiModel("检索条件DTO")public class QuerySkillDTO implements Serializable {    @ApiModelProperty("技能名称或编码")    private String nameOrCode;    @ApiModelProperty("技能类型")    private String category;    @ApiModelProperty("页数")    private int page = 0;    @ApiModelProperty("件数")    private int size = 10;

swagger展示视图就不截图了，几个注解简单的用法，稍微记载一下，便于以后再用。

0 0