OpenApiConfig.java 2.57 KB
package com.huaheng.control.management.utils.config;

import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import io.swagger.v3.oas.annotations.enums.ParameterIn;
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.info.License;
import io.swagger.v3.oas.models.media.Schema;
import io.swagger.v3.oas.models.media.StringSchema;
import io.swagger.v3.oas.models.parameters.Parameter;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import io.swagger.v3.oas.models.security.SecurityScheme;

/**
 * SpringDoc OpenAPI 配置类
 * @author     TanYibin
 * @createDate 2025年12月30日
 */
@Component
public class OpenApiConfig implements WebMvcConfigurer {

    private final static String SYSTEM_TOKEN =
        "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJDTUMiLCJpc3MiOiJodWFoZW5nLWNvbnRyb2wtbWFuYWdlbWVudC1jZW50ZXIiLCJleHAiOjQxMDI0MTU5OTksImlhdCI6MTc2NzU4MDc2NSwib3BlcmF0b3IiOiJDTUMiLCJqdGkiOiJlNTM4ZTMwNS03YmE2LTRlOTEtODM1MC1hMzhjY2QxZjJkNmYifQ.ktJsTSlDX1AjC99YwBPnMX06o_VallGSJIg2X5dw2Pk0ANJRIGg3kPrUK4vlqB8826nqGpn22yGgD4hfvntovjz0NW6xBqC-9Y-0P2OkwVw9HXWuIqEsWTNkjnYLwggKAvpxSBV6caLIdZ1HugBKtWyApIhvQKadFOHR8Pd8Xxo";

    /**
     * 配置 OpenAPI 基本信息
     */
    @Bean
    public OpenAPI customOpenAPI() {

        return new OpenAPI()
            .info(new Info().title("Huaheng Control Manager Center API 文档").version("1.0")
                .description("华恒软控一体平台 - 提供设备控制、任务管理、状态监控等完整的控制管理接口服务,包括设备发现、指令下发、状态查询、任务调度等核心功能")
                .license(new License().name("Apache 2.0").url("http://www.apache.org/licenses/LICENSE-2.0.html")))
            .addSecurityItem(new SecurityRequirement().addList("TOKEN")).components(new Components().addSecuritySchemes("TOKEN",
                new SecurityScheme().name("TOKEN").type(SecurityScheme.Type.APIKEY).description(SYSTEM_TOKEN).in(SecurityScheme.In.HEADER)));
    }

    /**
     * 资源处理器配置 - SpringDoc 会自动配置,这里可以移除或保留作为自定义
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/swagger-ui/**").resourceChain(false);
    }
}