@trapi/swagger/dist/config/type.d.ts

Generate Swagger files from a decorator APIs.

import type { CollectionFormat, Metadata, Options as MetadataOptions } from '@trapi/metadata';
import type { SecurityDefinitions } from '../type';
export type ServerOption = {
    url: string;
    description?: string;
};
export interface Options {
    /**
     * Generate a yaml file
     */
    yaml?: boolean;
    /**
     * Specify if an output file should be generated.
     *
     * default: true
     */
    output: boolean;
    /**
     * Generated swagger.{json|yaml} will output here.
     *
     * default: process.cwd()
     */
    outputDirectory: string;
    /**
     * Generated documentation base file name.
     *
     * default: swagger
     */
    outputFileName: string;
    /**
     * API host, expressTemplate.g. localhost:3000 or https://myapi.com
     */
    servers?: ServerOption[];
    /**
     * Metadata options or metadata itself.
     */
    metadata?: MetadataOptions | Metadata;
    /**
     * API version number; defaults to npm package version
     */
    version?: string;
    /**
     * API name; defaults to npm package name
     */
    name?: string;
    /**
     * 'API description; defaults to npm package description
     */
    description?: string;
    /**
     * API license; defaults to npm package license
     */
    license?: string;
    /**
     * Extend generated swagger spec with this object
     * Note that generated properties will always take precedence over what get specified here
     */
    specificationExtra?: Record<string, any>;
    /**
     * Security Definitions Object
     * A declaration of the security schemes available to be used in the
     * specification. This does not enforce the security schemes on the operations
     * and only serves to provide the relevant details for each scheme.
     */
    securityDefinitions?: SecurityDefinitions;
    /**
     * Default consumes property for the entire API
     */
    consumes?: string[];
    /**
     * Default produces property for the entire API
     */
    produces?: string[];
    /**
     * Default collectionFormat property for query parameters of array type.
     * Possible values are `csv`, `ssv`, `tsv`, `pipes`, `multi`. If not specified, Swagger defaults to `csv`.
     */
    collectionFormat?: `${CollectionFormat}`;
}
export type OptionsInput = Omit<Partial<Options>, 'servers'> & {
    servers?: string | string[] | ServerOption | ServerOption[];
};
//# sourceMappingURL=type.d.ts.map