在開發中我們經常會碰到這種情況：後臺開發人員在開發完介面之後給前臺人員呼叫，前臺人員對介面的作用以及介面中的引數往往不懂，這樣前臺不得不多次跟後臺人員溝通交流，很浪費時間。但使用Swagger後，這種情況就幾乎不存在了，因為後臺開發人員在寫介面的同時便把介面及引數的註釋寫好了，在Swagger頁面可以非常清楚明瞭的看到各個介面以及各個引數的意思。

        我們先看看效果圖，下圖中明確顯示了當前訪問的介面屬於"order-controller"，顯示了請求url路徑為"/orderNew/getOrder"，顯示了該介面的作用為"獲取某條訂單資訊"，顯示了這個介面所用到的三個引數以及三個引數的名稱以及型別。我們還可以點選下面的"Try it out!"按鈕來進行測試。有了它，後臺人員不用講解，前端人員自然能明白。

       下面就說下如何使用開發工具IntellijIDEA來搭建Swagger應用。

第一步： 首先新建一個空的Maven工程

第二步：在pom.xml檔案中新增如下依賴

 <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.4.1.RELEASE</version>
        <relativePath />
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>1.4.1.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>4.3.6.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>4.3.3.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <version>1.4.1.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.2.2</version>
            <exclusions>
                <exclusion>
                    <artifactId>spring-context</artifactId>
                    <groupId>org.springframework</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>spring-aop</artifactId>
                    <groupId>org.springframework</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>spring-beans</artifactId>
                    <groupId>org.springframework</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>spring-web</artifactId>
                    <groupId>org.springframework</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>spring-webmvc</artifactId>
                    <groupId>org.springframework</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>spring-core</artifactId>
                    <groupId>org.springframework</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>jackson-annotations</artifactId>
                    <groupId>com.fasterxml.jackson.core</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>slf4j-api</artifactId>
                    <groupId>org.slf4j</groupId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.2.2</version>
        </dependency>
    </dependencies>
 

        Application的程式碼如下

package com;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.support.SpringBootServletInitializer;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * test-sc
 * Created by Grady on 2017/4/18.
 */
@EnableSwagger2
@SpringBootApplication
//@ImportResource("classpath:/META-INF/spring/spring-dubbo-provider.xml")
@EnableAutoConfiguration//啟用自動配置
//@ComponentScan("com.filter,com.controller,com.manager,com.api.impl")
public class Application extends SpringBootServletInitializer {
    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(Application.class);
    }

    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }
}
 

     Controller類程式碼如下

package com.controller;

import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

/**
 * Created by dell16 on 2017/4/18.
 */
@RequestMapping("/orderNew")
@RestController
public class OrderController {

    @ApiOperation(value = "獲取某條訂單資訊")
    @RequestMapping(value = "/getOrder", method = RequestMethod.GET)
    public String getOrder(@ApiParam(value = "訂單編號",required = true) @RequestParam(value = "orderNo") String orderNo,
                              @ApiParam(value = "當前頁") @RequestParam(value = "pageNum",required = false) Integer pageNum,
                              @ApiParam(value = "每頁顯示數量") @RequestParam(value = "pageSize",required = false) Integer pageSize) {
        return "成功！";
    }
}