import { AlosaurOpenApiBuilder } from "https://deno.land/x/alosaur@v0.38.0/openapi/mod.ts";
For testing this builder use this editor: https://editor.swagger.io/
Constructors
new
AlosaurOpenApiBuilder(settings: AppSettings)Properties
private
appMetadata: MetadataArgsStorage<T>private
builder: OpenApiBuilderprivate
classes: ObjectKeyAny[]private
optional
namesDenoDocMap: ParsedNamesDocMapprivate
openApiMetadata: OpenApiArgsStorage<T>private
routes: RouteMetadata[]Methods
addDenoDocs(docs: any): AlosaurOpenApiBuilder<T>
addDescription(description: string): AlosaurOpenApiBuilder<T>
addServer(server: oa.ServerObject): AlosaurOpenApiBuilder<T>
addTitle(title: string): AlosaurOpenApiBuilder<T>
addVersion(version: string): AlosaurOpenApiBuilder<T>
getSpec(): oa.OpenAPIObject
print(): void
saveDenoDocs(path?: string): AlosaurOpenApiBuilder<T>
saveToFile(path?: string): AlosaurOpenApiBuilder<T>
Static Methods
create<T>(settings: AppSettings): AlosaurOpenApiBuilder<T>
parseDenoDoc(path?: string): Promise<any>