@spailybot/moleculer-auto-openapi
Version:
Generate openapi scheme for moleculer
20 lines (19 loc) • 1.05 kB
TypeScript
import type { Context, ServiceBroker } from 'moleculer';
import { addMappersFn, filterAliasesFn, OA_GENERATE_DOCS_INPUT, OA_GENERATE_DOCS_OUTPUT, OpenApiMixinSettings } from './types/index.js';
import type { ExcludeRequiredProps } from './types/utils.js';
import { Alias } from './objects/Alias.js';
export declare const defaultSettings: Required<ExcludeRequiredProps<Omit<OpenApiMixinSettings, 'assetsPath' | 'schemaPath' | 'openApiPaths' | 'UIOauthOptions'>>> & Partial<OpenApiMixinSettings>;
export declare class MoleculerOpenAPIGenerator {
private readonly broker;
private readonly settings;
private readonly logger;
private validator;
constructor(broker: ServiceBroker, settings: OpenApiMixinSettings);
private fetchServicesWithActions;
private mapAliases;
getAliases(ctx: Context): Promise<Array<Alias>>;
generateSchema(ctx: Context<OA_GENERATE_DOCS_INPUT>, { filterAliasesFn, addMappers }: {
filterAliasesFn: filterAliasesFn;
addMappers: addMappersFn;
}): Promise<OA_GENERATE_DOCS_OUTPUT>;
}