YelixOpenAPI - @murat/yelix

Constructors

new



YelixOpenAPI(params: OpenAPIParams)



_openAPI: OpenAPI | null

private



customValidationDescriptions: Record<string, (_: any) => string>



addNewEndpoint(apiDoc: NewEndpointParams): void



describeValidationRule(kind: string,
fn: (_: any) => string,
): boolean

Registers a custom validation rule description for a specific kind. If a description for the given kind already exists, it will be overridden.

private



generateYelixExample(yelixSchema: YelixValidationBase,
generationType?: "input" | "output",
): any



getJSON(): OpenAPI

private



getParamsFromPath(path: string)

private



getRandomDateBetween(start: Date,
end: Date,
): Date

private



getType(type: string)



getValidationRuleDescription(kind: string): (_: any) => string

private



yelixZodToJsonBodySchema(yelixSchema: ObjectZod<any>): OpenAPIExtenedRequestBodySchema

private



yelixZodToJsonSchema(yelixSchema: YelixValidationBase): OpenAPIDefaultSchema