1、Swagger2是什麼？

Swagger 是一款RESTFUL介面的文件線上自動生成+功能測試功能軟體。
Swagger 是一個規範和完整的框架，用於生成、描述、呼叫和視覺化 RESTful 風格的 Web 服務。總體目標是使客戶端和檔案系統作為伺服器以同樣的速度來更新。檔案的方法，引數和模型緊密整合到伺服器端的程式碼，允許API來始終保持同步。Swagger 讓部署管理和使用功能強大的API從未如此簡單。

2、Swagger2官網

官網地址

3.Swagger2的入門教程

3.1Swagger2的maven依賴

<!-- 構建Restful API -->
 


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

3.2RestApiConfig的配置

package com.lidong.dubbo.web.util;

import org.springframework.context.annotation.Bean;
import org.springframework
 
.context.annotation.ComponentScan;
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;

/**
 * @專案名稱:lidong-dubbo
 * @類名:RestApiConfig
 * @類的描述: Restapi的基本配置
 * @作者:lidong
 * @建立時間:2017/2/11 上午10:01
 * @公司:chni
 * @QQ:1561281670
 * @郵箱:[email protected]
 * @使用方法：Restful API 訪問路徑: http://localhost:8080/lidong-dubbo-web/swagger-ui.html
 */
@EnableWebMvc
@EnableSwagger2
@Configuration
@ComponentScan(basePackages ="com.lidong.dubbo")
public class RestApiConfig extends WebMvcConfigurationSupport {


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

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SpringMVC中使用Swagger2構建RESTful APIs")
                .termsOfServiceUrl("https://github.com/lidong1665")
                .contact(new Contact("請叫我小東子","http://blog.csdn.net/u010046908","[email protected]"))
                .version("1.0.0")
                .build();
    }

}

3.3在Controller中新增

@ApiOperation(value = "獲取使用者詳細資訊", notes = "根據url的id來獲取使用者詳細資訊")
    @ApiImplicitParam(name = "id", value = "使用者ID", required = true, dataType = "Long")
    @RequestMapping(value = "getUserForid/{id}", method = RequestMethod.GET)
    @ResponseBody
    public String getUser(@PathVariable int id) {
        try {
            return JsonUtil.bean2json(userService.getUserById(id));
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

3.4結果

程式碼地址