給項目添加swagger

1.什么是swagger

官方介紹：Swagger是一個規范且完整的框架，提供描述、生產、消費和可視化RESTful Web Service。
專業角度：Swagger是由龐大工具集合支撐的形式化規范。這個集合涵蓋了從終端用戶接口、底層代碼庫到商業API管理的方方面面。

2.為什么要用swagger

作為一個很懶的碼代碼的猿呢，對於一些API的理解總是很模糊不清，但是，總想着能直接驗證一下自己的理解就好了，而不是需要去項目寫測試代碼來驗證自己的想法。所以說，API文檔應該有直接運行的能力。而Swagger就是這樣的一個東西，它可以為已有項目的生成具備執行能力的樣式化API文檔，這樣可以極大的方便程序員對前端后台進行對接整合。

3.開發環境：

JDK:1.8

swagger：2.6.0

gradle依賴：

compile(
      "io.springfox:springfox-swagger2:2.6.1",
      "io.springfox:springfox-swagger-ui:2.6.1"
)

4.swagger配置類

通過注解將配置了注入spring

package com.zhoulei.config;


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
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;

/**
 * @author: lzhou
 * @date: 2018/09/07 14:09
 * @version: V1.0
 */
@Configuration
//@EnableWebMvc
@EnableSwagger2
public class SwaggerConfig{
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zhoulei.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Springboot測試項目")
                .description("如有調用問題請發送郵箱：[e-mail]")
                .contact(new Contact("EP-lzhou","http://www.baidu.com","[e-mail]"))
                .version("1.0")
                .build();
    }

}

5.編寫control類進行測試

@ResponseBody
    @RequestMapping(value = "/test", method = RequestMethod.POST)
    @ApiOperation(value ="Springboot測試接口" ,notes = "Springboot測試接口")
    public String Test(@RequestBody String info){
        return info;
    }

6.運行項目，輸入地址：http://localhost:9099/swagger-ui.html#!（自己的地址和端口）效果如下：