Swagger可以用来快速生成RESTful API文档,使后台开发人员与移动端开发人员更好的对接.
Maven dependency
1 | <dependency> |
配置Swagger
1 |
|
在springmvc的xml文件中加入相关配置
1 | <!--<bean class="com.gude.config.SwaggerConfig" /> 使用bean申明可以去掉@configuration--> |
类接口添加相关说明
1 | "HelloController", description = "Hello控制器") (value = |
- @ApiImplicitParam:对单个参数进行说明,其中dataType一定为小写
- @Api:标志这个类为Swagger资源
- @ApiOperation:描述了一种操作或通常针对特定的路径的HTTP方法。
更多注解可以查看官方说明
打开http://localhost:8080/project_name/swagger-ui.html ,project_name
表示你启动项目的名称,如果你以根目录启动则没有project_name
,当你看到如下界面就表示配置成功了
本次整合源码
参考官方文档