springboot项目搭建开发（四）

图片来源于网络，侵权请联系删除

前言

随着前后带分离的到来，后端更加专心于业务，前端专心于页面特效的实现，那么就需要一个约定好的文档来规范两者数据接口的一个调用，前端根据后台的数据结构进行动态渲染。接口文档一般由后端手写，亦或者apipost之类的接口测试工具进行文档生成。java也有多种接口文档的生成方式，这里我们来学习一下在springboot中SwaggerUI在线接口测试文档的搭建。

1.pox.xml配置

定义Swagger引入版本

 <swaggerui.version>2.9.2</swaggerui.version>

引入SwaggerUI

        <!-- 集成swagger -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swaggerui.version}</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swaggerui.version}</version>
        </dependency>

2.配置Bean加载入springboot程序

package org.yh.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket createApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包下controller生成API文档
                .apis(RequestHandlerSelectors.basePackage("org.yh.controller"))
                //为有@Api注解的Controller生成API文档
//                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                //为有@ApiOperation注解的方法生成API文档
//                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SwaggerUI演示")
                .description("yh-test")
                .version("1.0")
                .build();
    }
}

3.控制器注解标志文档内容

package org.yh.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * restful风格的api
 */
@RestController
@Api(tags = "测试控制器", value = "测试")
public class HelloController {

    @GetMapping(path = "/")
    @ApiOperation("你好呀，世界")
    public String hello() {
        return "hello world";
    }
}

4.查看运行结果

swagger运行结果