rckrdmrd
26f0e52ca7
Template base para proyectos SaaS multi-tenant. Estructura inicial: - apps/backend (NestJS API) - apps/frontend (React/Vite) - apps/database (PostgreSQL DDL) - docs/ (Documentación) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
30 lines
1.9 KiB
TypeScript
30 lines
1.9 KiB
TypeScript
import { ApiResponseOptions } from './decorators/api-response.decorator';
|
|
import { OpenAPIObject } from './interfaces';
|
|
import { ExtensionLocation, ExternalDocumentationObject, ParameterObject, SecurityRequirementObject, SecuritySchemeObject, ServerVariableObject } from './interfaces/open-api-spec.interface';
|
|
export declare class DocumentBuilder {
|
|
private readonly logger;
|
|
private readonly document;
|
|
setTitle(title: string): this;
|
|
setDescription(description: string): this;
|
|
setVersion(version: string): this;
|
|
setTermsOfService(termsOfService: string): this;
|
|
setContact(name: string, url: string, email: string): this;
|
|
setLicense(name: string, url: string): this;
|
|
setOpenAPIVersion(version: string): this;
|
|
addServer(url: string, description?: string, variables?: Record<string, ServerVariableObject>): this;
|
|
setExternalDoc(description: string, url: string): this;
|
|
setBasePath(path: string): this;
|
|
addTag(name: string, description?: string, externalDocs?: ExternalDocumentationObject): this;
|
|
addExtension(extensionKey: string, extensionProperties: any, location?: ExtensionLocation): this;
|
|
addSecurity(name: string, options: SecuritySchemeObject): this;
|
|
addGlobalResponse(...respones: ApiResponseOptions[]): this;
|
|
addGlobalParameters(...parameters: Omit<ParameterObject, 'example' | 'examples'>[]): this;
|
|
addSecurityRequirements(name: string | SecurityRequirementObject, requirements?: string[]): this;
|
|
addBearerAuth(options?: SecuritySchemeObject, name?: string): this;
|
|
addOAuth2(options?: SecuritySchemeObject, name?: string): this;
|
|
addApiKey(options?: SecuritySchemeObject, name?: string): this;
|
|
addBasicAuth(options?: SecuritySchemeObject, name?: string): this;
|
|
addCookieAuth(cookieName?: string, options?: SecuritySchemeObject, securityName?: string): this;
|
|
build(): Omit<OpenAPIObject, 'paths'>;
|
|
}
|