@sleeksky/alt-swagger
Version:
A fluent, programmatic API for generating OpenAPI 3.0 specifications with TypeScript support. Define REST API endpoints, schemas, parameters, and security using a simple, chainable syntax.
35 lines • 921 B
TypeScript
interface SwaggerSchema {
type?: string;
items?: SwaggerSchema;
properties?: {
[key: string]: SwaggerSchema;
};
example?: any;
required?: boolean;
$ref?: string;
}
declare function toSwaggerSchema(str: string): SwaggerSchema;
interface PathParameter {
in: string;
name: string;
schema: {
type: string;
example?: string;
};
required: boolean;
}
declare function pathParameters(str: string): PathParameter[];
declare function pathClean(path: string): string;
interface Parameter {
name: string;
in: string;
required: boolean;
schema: {
type: string;
example?: string;
};
}
declare function toParameter(inType: string, str: string | Parameter): Parameter;
export { toSwaggerSchema, pathParameters, pathClean, toParameter };
export type { SwaggerSchema, PathParameter, Parameter };
//# sourceMappingURL=utils.d.ts.map