swagger java api_Java后台管理系统（六）：集成 Swagger API

spring-boot作为当前最为流行的Java web开发脚手架，越来越多的开发者选择用其来构建企业级的RESTFul API接口。这些接口不但会服务于传统的web端(b/s)，也会服务于移动端。在实际开发过程中，这些接口还要提供给开发测试进行相关的白盒测试，那么势必存在如何在多人协作中共享和及时更新API开发接口文档的问题。

假如你已经对传统的wiki文档共享方式所带来的弊端深恶痛绝，那么尝试一下Swagger2 方式，一定会让你有不一样的开发体验。

使用 Swagger 集成文档具有以下几个优势：

功能丰富 ：支持多种注解，自动生成接口文档界面，支持在界面测试API接口功能；

及时更新 ：开发过程中花一点写注释的时间，就可以及时的更新API文档，省心省力；

整合简单 ：通过添加pom依赖和简单配置，内嵌于应用中就可同时发布API接口文档界面，不需要部署独立服务。

1 . 添加依赖

添加 Maven 依赖， 这里选择 2.8.0 版本。

io.springfox

springfox-swagger2

2.8.0

io.springfox

springfox-swagger-ui

2.8.0

2. 添加配置类

添加 swagger 配置类，在 kitty-boot 工程的 config 包下添加 SwaggerConfig 配置类。

packagecom.louis.kitty.boot.config;importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;importspringfox.documentation.builders.ApiInfoBuilder;importspringfox.documentation.builders.PathSelectors;importspringfox.documentation.builders.RequestHandlerSelectors;importspringfox.documentation.service.ApiInfo;importspringfox.documentation.spi.DocumentationType;importspringfox.documentation.spring.web.plugins.Docket;importspringfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration

@EnableSwagger2public classSwaggerConfig {

@BeanpublicDocket createRestApi(){return newDocket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())

.select()

.apis(RequestHandlerSelectors.any())

.paths(PathSelectors.any()).build();

}privateApiInfo apiInfo(){return newApiInfoBuilder()

.title("Kitty API Doc")

.description("This is a restful api document of Kitty.")

.version("1.0")

.build();

}

}

3. 启动测试

我们看到 Swagger 已经集成进来了，选择 sys-user-controller，依次点击 try it out -> execute，结果成功返回。

4. 常用注解

swagger 通过注解接口生成文档，包括接口名，请求方法，参数，返回信息等

@Api: 修饰整个类，用于controller类上

@ApiOperation: 描述一个接口，用户controller方法上

@ApiParam: 单个参数描述

@ApiModel: 用来对象接收参数,即返回对象

@ApiModelProperty: 对象接收参数时，描述对象的字段

@ApiResponse: Http响应其中的描述，在ApiResonse中

@ApiResponses: Http响应所有的描述，用在

@ApiIgnore: 忽略这个API

@ApiError: 发生错误的返回信息

@ApiImplicitParam: 一个请求参数

@ApiImplicitParam: 多个请求参数

5. 使用案例

packagecom.louis.kitty.admin.controller;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.web.bind.annotation.GetMapping;importorg.springframework.web.bind.annotation.RequestMapping;importorg.springframework.web.bind.annotation.RequestParam;importorg.springframework.web.bind.annotation.RestController;importcom.louis.kitty.admin.sevice.SysUserService;importio.swagger.annotations.Api;importio.swagger.annotations.ApiImplicitParam;importio.swagger.annotations.ApiOperation;

@Api(value= "用户控制器")

@RestController

@RequestMapping("user")public classSysUserController {

@AutowiredprivateSysUserService sysUserService;

@ApiOperation(value="获取用户信息", notes="根据用户ID获取用户信息")

@ApiImplicitParam(name= "userId", value = "用户ID", required = true, dataType = "Long")

@GetMapping(value="/findByUserId")publicObject findByUserId(@RequestParam Long userId) {returnsysUserService.findByUserId(userId);

}

@GetMapping(value="/findAll")publicObject findAll() {returnsysUserService.findAll();

}

}

6. 参考资料