Table of Contents

TXDataRedocOptions Class

Options that control the Redoc web interface published by a server component.

Remarks

Redoc is an open source tool that generates API documentation from an OpenAPI document. When enabled, it is available at the address /redoc, relative to the server base URL.

Syntax

Unit: XData.Comp.Server

TXDataRedocOptions = class(TRedocOptions);

Constructors

Name Description
Create Creates a new instance with all options set to their default values.

Methods

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

Properties

Name Description
CustomParams Gets or sets additional Redoc configuration parameters, in Name=Value format.
Enabled Indicates whether the Redoc endpoint is published by the server.