@solid-nestjs/rest-api/dist/helpers/swagger.helper.d.ts

solid-nestjs Rest-API utilities

import { SwaggerUiOptions } from '@nestjs/swagger/dist/interfaces/swagger-ui-options.interface';
/**
 * Recommended Swagger UI options for API documentation.
 *
 * @remarks
 * - `tagsSorter`: Sorts tags alphabetically in the Swagger UI.
 * - `operationsSorter`: Custom function to sort API operations by HTTP method order:
 *   GET, POST, PUT, PATCH, DELETE. Within each method, empty routes are shown first,
 *   followed by other routes in alphabetical order.
 *
 * @example
 * // Use with SwaggerModule.setup in NestJS
 * SwaggerModule.setup('api', app, document, swaggerRecomenedOptions);
 *
 * @see {@link https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/}
 */
export declare const swaggerRecomenedOptions: SwaggerUiOptions;
//# sourceMappingURL=swagger.helper.d.ts.map