Swagger configuration

Complete configuration items, default values, example values, and enumeration descriptions for Lodsve Boot Swagger configuration.

Autoconfiguration requires lodsve.swagger.enabled: true.

Configuration itemsTypeDefault valueExample valueDescription
lodsve.swagger.enabledbooleanfalsetrueSwagger automatically configures the switch.
lodsve.swagger.versionStringNone1.0.0Interface version.
lodsve.swagger.titleStringSwagger的Rest接口文档 (Swagger REST API documentation)Sample Service APIDocument title.
lodsve.swagger.descriptionStringNoneSample service API documentationDocument description.
lodsve.swagger.terms-of-service-urlStringNonehttps://example.com/termsTerms of Service Address.
lodsve.swagger.licenseStringNoneApache-2.0License name.
lodsve.swagger.license-urlStringNonehttps://www.apache.org/licenses/LICENSE-2.0License address.
lodsve.swagger.contact.nameStringNoneAPI SupportContact name.
lodsve.swagger.contact.urlStringNonehttps://example.comContact homepage.
lodsve.swagger.contact.emailStringNoneapi@example.comContact email.
lodsve.swagger.global-parameters[].nameStringNoneX-Request-IdGlobal parameter name.
lodsve.swagger.global-parameters[].descriptionStringNoneRequest trace IDGlobal parameter description.
lodsve.swagger.global-parameters[].typeStringNonestringType values: integer, string, boolean, number, object.
lodsve.swagger.global-parameters[].scopeStringNoneheaderPosition values: query, header, path, cookie, form, formData, body.
lodsve.swagger.global-parameters[].requiredbooleanfalsefalseIs it required?
lodsve.swagger.auth.enabledbooleanfalsefalseWhether to enable Header authentication parameters.
lodsve.swagger.auth.keyStringNoneAuthorizationAuthentication header name.
Architecture diagram