搭建swagger2和 spring boot结合

最新推荐文章于 2025-02-27 13:18:29 发布

邢邢邢

最新推荐文章于 2025-02-27 13:18:29 发布

阅读量79

点赞数

本文链接：https://blog.youkuaiyun.com/pink_s/article/details/102466168

版权

本文详细介绍如何在Spring Boot 2.0.3版本中集成并配置Swagger2，包括依赖引入、SwaggerConfig类编写及常用注解应用，帮助快速生成API文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

创建boot项目 2.0.3 版

导入boot对应的 swagger jar包

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<!-- swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

配置SwaggerConfig 类
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
.select().apis(RequestHandlerSelectors
.basePackage(“com.bksw.controller”)) // 扫描api接口路径
.paths(PathSelectors.any()).build();//可以根据url路径设置哪些请求加入文档，忽略哪些请求
}
```
     private ApiInfo apiInfo() {
         return new ApiInfoBuilder().title("XXXXXX接口文档") // 设置文档的标题
         		.description("XXXXX")//设置文档的描述 ： "更多内容请关注：http://www.abc.com"
         		.termsOfServiceUrl("http://www.kakasys.com/")//设置文档的License信息
         		.version("1.0").build(); //设置文档的版本信息
     }
```
这样简单的 swagger2 和 boot 已经可以使用
swagger2常用的注解有：
1. 用在Controller中，标记一个Controller作为swagger的文档资源
  @Api(value = “登录”,description = “用户登录相关接口”)
2. 该注解用在Controller的方法中，用于注解接口
  @ApiOperation(value = “资料查询”, notes = “资料查询”)
3. 该注解用在方法的参数中。
  @ApiOperation(value = “添加权限”,notes = “插入权限”,response = JsonData.class)
4. 该注解用在Controller的方法中，用于注解方法的返回状态。
  @ApiResponses({
  @ApiResponse(code = 200,message = “成功！”),
  @ApiResponse(code = 401,message = “未授权！”),
  @ApiResponse(code = 404,message = “页面未找到！”),
  @ApiResponse(code = 403,message = “出错了！”)
  })
5. 该注解用在实体类中。
  @ApiModel(value = “JsonData”,description = “返回的数据类型”)
6. 该注解用在Controller的方法中，同ApiParam的作用相同，但是比较建议使用ApiParam。
  @ApiImplicitParam(name = “user”,value = “用户详细实体user”)
7. 该注解用在实体类的字段中。
  @ApiModelProperty(name = “code”,value = “状态code”,notes = “返回信息的状态”)