@breadstone/archipel-platform-openapi
Classes
| Class | Description |
|---|---|
| SwaggerFeatureDiscovery | Centralizes the discovery of Swagger features declared across backend modules. |
| SwaggerFeatureRegistry | Registry service for dynamically discovered Swagger features. Collects feature configurations from |
| SwaggerMultiDocumentService | - |
| SwaggerTheme | The swagger theme class |
Interfaces
| Interface | Description |
|---|---|
| IFeatureSwaggerConfig | - |
| ISwaggerFeatureMetadata | - |
Variables
| Variable | Description |
|---|---|
| APP_VERSION | Application version shown in the Swagger document. |
| PLATFORM_OPENAPI_CONFIG_ENTRIES | All configuration entries required by platform-openapi. |
| SWAGGER_CONTACT_EMAIL | Contact e-mail displayed in the Swagger document. |
| SWAGGER_CONTACT_NAME | Contact name displayed in the Swagger document. |
| SWAGGER_CONTACT_URL | Contact URL displayed in the Swagger document. |
| SWAGGER_FEATURE_METADATA_KEY | - |
Functions
| Function | Description |
|---|---|
| Api | Custom Swagger Decorator This decorator wraps all necessary Swagger decorators into one. |
| getRegisteredSwaggerFeatures | Retrieves all Swagger features that have been registered through the decorator. |
| getSwaggerFeatureMetadata | Get the Swagger feature metadata from a module class |
| SwaggerFeature | Decorator to register a module as a Swagger feature. This allows the SwaggerMultiDocumentService to automatically discover and create documentation. |