Class SpringdocAutoConfiguration

java.lang.Object

tech.riemann.nif.openapi.SpringdocAutoConfiguration

@AutoConfiguration
@EnableConfigurationProperties({SpringdocConfigurationProperties.class,NifOpenApiProperties.class})
public class SpringdocAutoConfiguration
extends Object

swagger 配置

凭证方式说明(@SecurityScheme 仅决定 swagger 调试页"Authorize"后请求如何附加凭证,与后端无关): 本注解配置为 APIKey/HEADER——调试请求发送 Authorization: <token>(裸值), 与 nif auth HttpServletAuthService.token() 的 getHeader("Authorization") 直取裸值解析格式一致,调试页可直接调用受保护接口。

若改用标准 Bearer(type=HTTP, scheme="bearer"):swagger 会发送 Authorization: Bearer <token>, 此时需后端 token() 增加 "Bearer " 前缀剥离,否则认证失败。

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENABLED_PROP	OpenAPI/Swagger 总开关属性名。

Constructor Summary

Constructors

Constructor	Description
SpringdocAutoConfiguration()

Method Summary

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ENABLED_PROP

public static final String ENABLED_PROP

OpenAPI/Swagger 总开关属性名。 默认关闭(P1-12):避免在生产环境默认暴露 /v3/api-docs 与 Swagger UI 形成 API 攻击面。 仅当显式 nif.openapi.enabled=true 时才开启（生产环境保持默认关闭即可）。

默认关闭由

invalid reference

NifOpenApiProperties#isEnabled()

字段默认值 false 与 OpenApiSecurityDefaultsEnvironmentPostProcessor 注入的 springdoc.*.enabled=false 共同保证, 不依赖任何配置文件。

See Also:

• Constant Field Values

Constructor Details

SpringdocAutoConfiguration

public SpringdocAutoConfiguration()