SpringBoot整合Swagger2

相信各位在公司写API文档数量应该不少，当然如果你还处在自己一个人开发前后台的年代，当我没说，如今为了前后台更好的对接，还是为了以后交接方便，都有要求写API文档。

手写Api文档的几个痛点：

文档需要更新的时候，需要再次发送一份给前端，也就是文档更新交流不及时。
接口返回结果不明确
不能直接在线测试接口，通常需要使用工具，比如postman
接口文档太多，不好管理

Swagger也就是为了解决这个问题，当然也不能说Swagger就一定是完美的，当然也有缺点，最明显的就是代码移入性比较强。

其他的不多说，想要了解Swagger的，可以去Swagger官网，可以直接使用Swagger editor编写接口文档，当然我们这里讲解的是SpringBoot整合Swagger2，直接生成接口文档的方式。

添加依赖

<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.6.1</version>
</dependency>

<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger-ui</artifactId>
	<version>2.6.1</version>
</dependency>

新建Swagger配置类SwaggerConfig

需要要注意的是里面配置了api文件也就是controller包的路径，不然生成的文档扫描不到接口。

下面的设置扫描选择器时也可选择整个Controller包或者对@RestController的所有方法进行自动扫描。

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //设置扫描选择器
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //文档内容配置信息
                .title("小豆借阅接口文档")
                .description("接口文档")
                .termsOfServiceUrl("https://www.liyawei.xyz")
                .version("1.0")
                .build();
    }
}

用@Configuration注解该类，等价于XML中配置beans；用@Bean标注方法等价于XML中配置bean。

Application.class 加上注解@EnableSwagger2 表示开启Swagger

Restful风格的Controller

@RestController
@RequestMapping("/api")
public class ApiController {

    private static final Logger logger = LoggerFactory.getLogger(BookController.class);

    @Autowired
    IBookService bookService;

    /**
     * 根据图书条码获取图书信息
     *
     * @param barcode 图书条码
     * @return
     */
    @GetMapping(value = "/book/{barcode}", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
    @ApiOperation("根据图书条码获取图书信息")
    public String getBookByBarcode(@PathVariable("barcode") String barcode) {
        ClientResponseJSONBean clientResponseJSONBean = null;
        //参数校验
        if (Strings.isBlank(barcode)) {
            clientResponseJSONBean = ClientResponseJSONBean.getFailedClientResponseJSONBean();
            clientResponseJSONBean.setMessage("条码不能为空！");
            logger.error("查询的条码为空");
            return clientResponseJSONBean.toJSONString();
        }

        Map map = bookService.getByBarcode(barcode);
        if (map == null) {
            clientResponseJSONBean = ClientResponseJSONBean.getFailedClientResponseJSONBean();
            clientResponseJSONBean.setMessage("无该条码的商品信息！");
            logger.error("无该条码的商品信息：barcode ------>" + barcode);
            return clientResponseJSONBean.toJSONString();
        }

        clientResponseJSONBean = ClientResponseJSONBean.getSuccessClientResponseJSONBean();
        clientResponseJSONBean.setData(map);
        return clientResponseJSONBean.toJSONString();
    }

启动springboot项目

在浏览器中输入swagger-ui的地址即可查看生成的接口文档

http://localhost:8066/swagger-ui.html

Swagger相关注解

swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。

@Api：修饰整个类，描述Controller的作用
@ApiOperation：描述一个类的一个方法，或者说一个接口
@ApiParam：单个参数描述
@ApiModel：用对象来接收参数
@ApiProperty：用对象接收参数时，描述对象的一个字段
@ApiResponse：HTTP响应其中1个描述
@ApiResponses：HTTP响应整体描述
@ApiIgnore：使用该注解忽略这个API
@ApiError ：发生错误返回的信息
@ApiImplicitParam：一个请求参数
@ApiImplicitParams：多个请求参数

Aweew