swagger 常用注解

哈哈哈  自己也不知道 swagger  但是知道在项目中怎么用 哈哈

1.常用注解

1、与模型相关的注
两个注解:
@ApiModel:用在模型类上,对模型类做注释;
@ApiModelProperty:用在属性上,对属性做注释
2、与接口相关的注解
六个注解:
@Api:用在controller上,对controller进行注释;
@ApiOperation:用在API方法上,对该API做注释,说明API的作用;
@ApiImplicitParams:用来包含API的一组参数注解,可以简单的理解为参数注解的集合声明;
@ApiImplicitParam:用在@ApiImplicitParams注解中,也可以单独使用,说明一个请求参数的各个方面,该注解包含的常用选项有:
paramType:参数所放置的地方,包含query、header、path、body以及form,最常用的是前四个。
name:参数名;
dataType:参数类型,可以是基础数据类型,也可以是一个class;
required:参数是否必须传;
value:参数的注释,说明参数的意义;
defaultValue:参数的默认值;
@ApiResponses:通常用来包含接口的一组响应注解,可以简单的理解为响应注解的集合声明;
@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
code:即httpCode,例如400 
message:信息,例如"请求参数没填好"

2.项目中使用

1 @ResponseBody
2     @RequestMapping("/info")
3     @ApiOperation(value="根据期刊的Id查询期刊详情", httpMethod = "GET", notes = "根据期刊的Id查询期刊详情")
4     public Periodical listInfo(@ApiParam(required = true, name="id", value="")@RequestParam(value="id", required=true)String id,
5                                        HttpServletRequest request, HttpServletResponse response) {

3.自己学艺不精就知道这么一点 可以给各位帮助

自己可以试试 

 

哈哈哈  吐槽吧   我喜欢与不同意见的人交流  让彼此相互进步

posted @ 2018-06-08 11:49  胖头陀春天  阅读(223)  评论(0编辑  收藏  举报