通過本篇文章，你可以學會通過配置生成介面文件，再也不用通過Postman來測試自己的介面啦。。。

一、環境

1. JAVA8

2. MAVEN 3.0.5

3. IDEA 2016.2.5

4. spring boot 1.4.1

二、相關依賴

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

三、配置

設定了一些預設顯示的api相關資訊，最後上截圖的時就可以比較清楚的看到。

	
@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("info.xiaomo.website"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2構建RESTful APIs")
                .description("api根地址：http://api.xiaomo.info:8080/")
                .termsOfServiceUrl("https://xiaomo.info/")
                .contact("小莫")
                .version("1.0")
                .build();
    }
}
 

四、相關注解解讀

1. @Api

用在類上，說明該類的作用
@Api(value = "UserController", description = "使用者相關api")

2. @ApiOperation

用在方法上，說明方法的作用
@ApiOperation(value = "查詢使用者", notes = "查詢使用者", httpMethod = "GET", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)

3 @ApiImplicitParams

用在方法上包含一組引數說明

4. @ApiImplicitParam

用在@ApiImplicitParams註解中，指定一個請求引數的各個方面
paramType：引數放在哪個地方
header–>請求引數的獲取：@RequestHeader
query–>請求引數的獲取：@RequestParam
path（用於restful介面）–>請求引數的獲取：@PathVariable
body（不常用）
form（不常用）
name：引數名
dataType：引數型別
required：引數是否必須傳
value：引數的意思
defaultValue：引數的預設值

5. @ApiResponses

用於表示一組響應

6. @ApiResponse

用在@ApiResponses中，一般用於表達一個錯誤的響應資訊
code：數字，例如400
message：資訊，例如”請求引數沒填好”
response：丟擲異常的類

7. @ApiModel

描述一個Model的資訊（這種一般用在post建立的時候，使用@RequestBody這樣的場景，請求引數無法使用@ApiImplicitParam註解進行描述的時候）
@ApiModel(value = "使用者實體類")

8. @ApiModelProperty

描述一個model的屬性
@ApiModelProperty(value = "登入使用者")

五、 和Swagger UI的整合

首先，從github swagger-ui 上下載Swagger-UI, 把該專案dist目錄下的內容拷貝到專案的resources的目錄public下。

六、訪問