Swagger常用注解使用说明一二

Swagger用于生成API说明文档,替代传统的手工书写API文档的方式。

项目中一般需要有一个配置类,将@EnableSwagger2+@Configuration注解添加到Swagger配置类上,用于开启Swagger注解。

常用的注解一般有以下几个;

@Api(tags = "Book服务")

用于Controller类上,说明此Controller类用于提供什么功能。

@ApiOperation(value = "指定id的书籍详细信息查询接口", notes = "使用注意事项", tags = {"作用1", "作用2"})

用于Controller类中的方法上,对此方法对应的api的作用,使用注意事项的说明。

@ApiImplicitParams( value = {

    @ApiImplicitParam( name = "参数名称1", value = "参数说明", required = true, dataType = 参数类型, defaultValue = 参数默认值, paramType = 参数类型),

    @ApiImplicitParam( name = "参数名称2", value = "参数说明", dataType = 参数类型, defaultValue = 参数默认值, paramType = 参数类型)

})

和@ApiOperation结合使用在方法上,进一步说明方法的入参,参数名称,作用,类型,默认值,是否必须等。

@ApiResponses( value = {

    @ApiResponse( code = 200, message = "成功", response = Book.class)

})

和@ApiOperation结合使用在方法上,说明方法的返回类型。

@ApiModel(value="book"),用在方法返回类上,说明这个类的作用,类的属性使用@ApiModelProperty注解。

@ApiIgnore用在类或方法上,被注解的类和方法就不会显示在文档里。

这几个注解足以。

猜你喜欢

转载自blog.csdn.net/suoyx/article/details/108976762