swagger ui和spring boot集成生成api文檔

作者：小莫
鏈接：https://www.zhihu.com/question/28119576/answer/134580038
來源：知乎
著作權歸作者所有。商業轉載請聯系作者獲得授權，非商業轉載請注明出處。

一、環境
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：參數的默認值

@ApiImplicitParams({
        @ApiImplicitParam(name = "id", value = "唯一id", required = true, dataType = "Long", paramType = "path"),
})

5. @ApiResponses

用於表示一組響應

6. @ApiResponse

用在@ApiResponses中，一般用於表達一個錯誤的響應信息
code：數字，例如400
message：信息，例如”請求參數沒填好”
response：拋出異常的類

@ApiResponses(value = {  
          @ApiResponse(code = 400, message = "No Name Provided")  
  })

7. @ApiModel

描述一個Model的信息（這種一般用在post創建的時候，使用@RequestBody這樣的場景，請求參數無法使用@ApiImplicitParam注解進行描述的時候）
@ApiModel(value = "用戶實體類")

8. @ApiModelProperty

描述一個model的屬性
@ApiModelProperty(value = "登錄用戶")

五、 和Swagger UI的集成

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

六、訪問

http://localhost:8080/swagger-ui.html 就可以看到效果如下