SpringBoot整合Swagger 文档框架 （一）

前后端分离开发中，前端和后端主要通过api来进行交互访问，所以两个如何进行高效率的工作交流，一个好的api接口是少不了的。

在这儿使用springboot整合swagger文档框架，来实现api接口文档的自动生成。

1.创建maven项目，在pom.xml中导入jar包

<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>

2.配置swagger

package com.example.demo.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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Created by IntelliJ IDEA.
 * User: ke li
 * Date: 2018/7/19
 * Time: 15:05
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("这是ke ke的关于swagger的测试")
                .description("2018.7.19上线版本")
                .contact(new Contact("ke ke",null,null))
                .version("1.0")
                .build();
    }


}

3.然后添加几个controller接口，并通过注解@Api，@ApiOperation进行接口说明

@RequestMapping("test")
@RestController
@Api(value = "TEST",description = "test controller")
public class TestController {

    @RequestMapping(value = "test",method = RequestMethod.GET)
    @ResponseBody
    @ApiOperation(value = "get 测试")
    public String testGet(){
        return "hello ,this is get";
    }

    @RequestMapping(value = "test",method = RequestMethod.POST)
    @ResponseBody
    @ApiOperation(value = "post 测试")
    public String testPost(){
        return "hello, this is post";
    }

    @RequestMapping(value = "test",method = RequestMethod.PUT)
    @ResponseBody
    @ApiOperation(value = "put 测试")
    public String testPut(){
        return "hello, this is put";
    }

    @RequestMapping(value = "test",method = RequestMethod.DELETE)
    @ResponseBody
    @ApiOperation(value = "delete 测试")
    public String testDelete(){
        return "hello, this is delete";
    }

}

4.最后启动项目，在浏览器地址栏中输入http://localhost:8080/swagger-ui.html，即可看到api文档