REST with Spring Boot 2


Open Source Your Knowledge, Become a Contributor

Technology knowledge has to be shared and made accessible for free. Join the movement.

Create Content


Swagger 可以快速產生 REST API 的 documentation,並且提供 UI 介面可以直接呼叫來做測試。

在 Spring Boot 中引入 Swagger 的方法如下

在 pom.xml 中加入 dependencies



撰寫 Swagger 相關設定

在 java source code 裡面創一個 class,並寫如下範例的程式碼

public class SwaggerConfig {
    public Docket buildDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                // 提供 API 相關的資訊,不想設定可以跳過這個 apiInfo call
                // 設定 base package,只有在這個 package 底下的 REST API 才會加入 Swagger 中
                // 如果不想指定,也可以用 RequestHandlerSelectors.any() 代表所有的 REST API

    private ApiInfo buildApiInf() {
        return new ApiInfoBuilder()
                .title("System RESTful API documentation")
                .contact(new Contact("Nier", "", ""))

在 REST API 層,也可以加一些 annotation 來額外提供資訊給 Swagger。

如果某個 API 不需要加入 Swagger 中,只需要在 API 上面加上 @ApiIgnore 註解就可以了。

啟動 Spring Boot Server 後,前往 http://localhost:8080/swagger-ui.html 就可以看到 Swagger UI 的介面。

Open Source Your Knowledge: become a Contributor and help others learn. Create New Content