S SmartDocs
Series: Java java 38 lines · Updated 2026-04-09

OpenApiConfig.java

Java/Baasid/src/main/java/com/baasid/config/OpenApiConfig.java

package com.baasid.config;

import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import io.swagger.v3.oas.models.security.SecurityScheme;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * OpenAPI(Swagger)文件設定:API 標題、版本、說明,以及全域 JWT Bearer 驗證方式。
 * <p>
 * 開發時可透過 {@code /swagger-ui.html} 測試需帶 {@code Authorization: Bearer &lt;token&gt;} 的端點。
 */
@Configuration
public class OpenApiConfig {

    @Bean
    public OpenAPI openAPI() {
        final String securitySchemeName = "Bearer Token";

        return new OpenAPI()
                .info(new Info()
                        .title("Baasid Goods API")
                        .version("1.0.0")
                        .description("Baasid 後端面試專案 — 商品管理 API"))
                // 所有路徑預設套用下列 security scheme(實際仍依 Security 設定與各 Controller 為準)
                .addSecurityItem(new SecurityRequirement().addList(securitySchemeName))
                .components(new Components()
                        .addSecuritySchemes(securitySchemeName,
                                new SecurityScheme()
                                        .name(securitySchemeName)
                                        .type(SecurityScheme.Type.HTTP)
                                        .scheme("bearer")
                                        .bearerFormat("JWT")));
    }
}

Related articles