Skip to main content

IQApiDocs

@quik/core

@quik/core / IQApiDocs

Interface: IQApiDocs

Defined in: features/QApiDocs.ts:10

Methods​

getApiJson()​

getApiJson(options?): Record<string, unknown>

Defined in: features/QApiDocs.ts:11

Parameters​

options?​

QApiDocsOptions

Returns​

Record<string, unknown>

getApiYaml()​

getApiYaml(options?): string

Defined in: features/QApiDocs.ts:13

Parameters​

options?​

QApiDocsOptions

Returns​

string

getEntityJson()​

getEntityJson(): Promise<Record<string, unknown>>

Defined in: features/QApiDocs.ts:15

Returns​

Promise<Record<string, unknown>>