TXDataSwaggerUIOptions Class
Options that control the Swagger UI web interface published by a server component.
Remarks
When enabled, the Swagger UI is available at the address /swaggerui, relative to the server base URL.
Syntax
Unit: XData.Comp.Server
TXDataSwaggerUIOptions = class(TPersistent);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 TXDataSwagger​UIOptions instance. |
Properties
| Name | Description |
|---|---|
| CustomParams | Gets or sets additional parameters passed to the Swagger UI JavaScript object, in Name=Value format. |
| DisplayOperationId | Indicates whether Swagger UI displays the operation id of each endpoint. |
| DocExpansion | Gets or sets how much of the operation list Swagger UI expands by default. |
| Enabled | Indicates whether the Swagger UI endpoint is published by the server. |
| ShowFilter | Indicates whether Swagger UI displays a filter box to search for API operations. |
| TryItOutEnabled | Indicates whether Swagger UI starts in "try out" mode. |