Swagger 配置

Lodsve Boot Swagger 配置的完整配置项、默认值、示例值和枚举说明。

自动配置要求 lodsve.swagger.enabled: true。

配置项类型默认值示例值说明
lodsve.swagger.enabledbooleanfalsetrueSwagger 自动配置开关。
lodsve.swagger.versionString无1.0.0接口版本。
lodsve.swagger.titleStringSwagger的Rest接口文档示例服务 API文档标题。
lodsve.swagger.descriptionString无示例服务接口文档文档描述。
lodsve.swagger.terms-of-service-urlString无https://example.com/terms服务条款地址。
lodsve.swagger.licenseString无Apache-2.0许可证名称。
lodsve.swagger.license-urlString无https://www.apache.org/licenses/LICENSE-2.0许可证地址。
lodsve.swagger.contact.nameString无API 支持联系人名称。
lodsve.swagger.contact.urlString无https://example.com联系人主页。
lodsve.swagger.contact.emailString无api@example.com联系人邮箱。
lodsve.swagger.global-parameters[].nameString无X-Request-Id全局参数名称。
lodsve.swagger.global-parameters[].descriptionString无请求追踪 ID全局参数描述。
lodsve.swagger.global-parameters[].typeString无string类型取值:integer、string、boolean、number、object。
lodsve.swagger.global-parameters[].scopeString无header位置取值:query、header、path、cookie、form、formData、body。
lodsve.swagger.global-parameters[].requiredbooleanfalsefalse是否必填。
lodsve.swagger.auth.enabledbooleanfalsefalse是否启用 Header 认证参数。
lodsve.swagger.auth.keyString无Authorization认证 Header 名称。