1.概述
在创建REST API时,良好的文档是有用的。
此外,API中的每个更改都应在参考文档中同时描述。手动完成这项工作是一项繁琐的工作,因此该过程的自动化是不可避免的。
在本教程中,我们将查看Swagger 2的Spring REST Web服务。在本文中,我们将使用Swagger 2规范的Springfox实现。
2.把Swagger集成到项目中
添加maven依赖
要使用Swagger UI,需要一个额外的Maven依赖项:
Java配置
Swagger的配置主要以Docket bean为中心
定义Docket bean 之后,其select()方法返回ApiSelectorBuilder的一个实例,它提供了一种控制Swagger公开的端点的方法。
并不总是希望公开整个API的文档。您可以通过将参数传递给Docket类的apis()和paths()方法来限制Swagger的响应。
如下所示,RequestHandlerSelectors允许使用any或none谓词,但也可以用于根据基础包,类注释和方法注释过滤API。
如上所示,RequestHandlerSelectors允许使用any或none谓词,但也可以用于根据基础包,类注释和方法注释过滤API。
PathSelectors使用谓词提供额外的过滤,这些谓词扫描应用程序的请求路径。您可以使用 any(), none(),regex()或 ant()。
在下面的示例中,我们将使用ant()谓词指示Swagger仅包含特定包中的控制器和特定路径。
注解使用
下面对几个最常用的做例子说明:
@EnableSwagger2 :用在springboot启动类上,表示启用swagger
@Api(“xxx模块”):一般用在controller类上
@ApiOperation(“添加”)用在mapping映射的方法上
@ApiModel:用在实体类上
@ApiModelProperty(“xxx名称”):用在实体类的属性上
@ApiParam(“xxx的Id”):用在
广州芦苇科技Java开发团队
芦苇科技-广州专业互联网软件服务公司
抓住每一处细节 ,创造每一个美好
关注我们的公众号,了解更多
想和我们一起奋斗吗?lagou搜索“ 芦苇科技 ”或者投放简历到 [email protected] 加入我们吧
关注我们,你的评论和点赞对我们最大的支持