Table of Contents

TXDataSwaggerOptions Class

Options that control the OpenAPI (Swagger) document published by a server component.

Remarks

When enabled, the server publishes the OpenAPI document of the API at the address /openapi/swagger.json, relative to the server base URL.

Syntax

Unit: XData.Comp.Server

TXDataSwaggerOptions = class(TPersistent);

Methods

Name Description
Assign Copies all option values from another TXDataSwaggerOptions instance.

Properties

Name Description
AuthMode Gets or sets the authentication scheme declared in the generated OpenAPI document.
DefaultTagGroup Gets or sets the tag group under which tags with no explicit group are listed.
Enabled Indicates whether the OpenAPI document endpoint is published by the server.