Springdoc OpenAPI UI（Swagger）爬坑記錄（持續更新）

如果純粹只是要Swagger界面，那就只需要把Dependency加進去，Run起來連線到:8080/swagger-ui.html就可以了，但是Swagger有很多東西其實可以額外做設定，讓他變得更實用

下面我就從加入Dependency開始，把在Spring Boot專案的設定流程都做個記錄

環境設定

安裝Swagger

我們只需要在Maven或Gradle上加入這個Dependency就可以了：Springdoc OpenAPI UI

Build完Run起來，在瀏覽器中連線到 localhost:8080/swagger-ui.html

如果一切順利，你就會看到Swagger的界面，跟一堆你已經寫好的API

設定檔

如果要進行下面的設定，我們就會需要設定檔來對Swagger進行設定

在Spring Boot的package底下建立一個Java Class，命名為OpenApi30Config，然後把底下這些貼進去

import org.springframework.context.annotation.Configuration;

@Configuration

public class OpenApi30Config {

}

爬坑

問題一：OpenAPI definition是啥鬼，可以改掉嗎

當然可以 在剛剛建立的設定檔中，加入下面這個Spring Boot Annotation

@OpenAPIDefinition(info = @Info(title = "取一個看得懂的名字", version = "v1"))

存檔，Run，完工

問題二：JWT怎麼加

哈哈，這個坑我搞超久 在剛剛建立的設定檔中，加入下面這個Annotation

@SecurityScheme(
        name = "bearerAuth",
        type = SecuritySchemeType.HTTP,
        bearerFormat = "JWT",
        scheme = "bearer"
)

然後到Controller那邊，找出需要JWT的API並加入這個Annotation

@Operation(security = @SecurityRequirement(name = "bearerAuth"))

存檔，Run，會發現Swagger出現了這個按鈕

點進去會彈出一個視窗，把JWT填進去再按下Authorize，Swagger就會自動在Header那邊加入JWT了

問題三：我腦子不行，記不得API Name，可以加註釋嗎

當然，Swagger的存在就是為了這狀況而生的

在API的Controller那邊，加入這個Annotation

@Operation(summary = "我是註釋")

存檔，Run，完工

問題四：為啥我的API跟彩虹一樣，明明我只用POST啊

忘記設定method囉，在@RequestMapping裡加入method = RequestMethod.POST即可