背景

最近在做一個Spring Boot的專案，介面寫的差不多了，後續大概要和前端對接。眾所周知後端和前端的溝通是非常耗時和費力的，這時候有一個完善的介面文件會帶來很大的幫助。Swagger就是一個非常好的選擇。

---

新增依賴

Gradle工程新增如下依賴：

    compile("io.springfox:springfox-swagger-ui:2.6.1")
    compile("io.springfox:springfox-swagger2:2.6.1")複製程式碼

Maven工程新增如下依賴：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.6.1</version>
    <scope>compile</scope>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.6.1</version>
    <scope>compile</scope>
</dependency>複製程式碼

——————

修改程式碼

為Applicaion類新增Swagger的註解：

@SpringBootApplication
@EnableSwagger2
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}複製程式碼

建立一個配置類，防止將Spring預設的錯誤處理等介面放入文件中。

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2).select()
                .apis(Predicates.not(RequestHandlerSelectors.basePackage("org.springframework.boot")))
                .build();
    }
}複製程式碼

---

結果

啟動應用，訪問"/swagger-ui.html",檢視介面文件。

甚至可以直接測試介面。

感想

還是要善於使用各種開發工具。