Skip to main content

@cuple/openapi

Functions​

convertDefinitionsToOpenAPI()​

convertDefinitionsToOpenAPI(definitions): Record<string, OpenAPISchemaObject>

Defined in: schema-converter.ts:20

Parameters​

definitions​

SchemaDefinitions

Returns​

Record<string, OpenAPISchemaObject>

convertPropertiesToOpenAPI()​

convertPropertiesToOpenAPI(props): object

Defined in: schema-converter.ts:66

Parameters​

props​

Record<string, PropertyInfo>

Returns​

object

properties​

properties: Record<string, OpenAPISchemaObject>

required​

required: string[]

convertSchemaToOpenAPI()​

convertSchemaToOpenAPI(schema): OpenAPISchemaObject

Defined in: schema-converter.ts:30

Parameters​

schema​

Schema

Returns​

OpenAPISchemaObject

generateOpenAPI()​

generateOpenAPI(filePath, variableName, options?): OpenAPIDocument

Defined in: generator.ts:206

Parameters​

filePath​

string

variableName​

string

options?​

GenerateOpenAPIOptions

Returns​

OpenAPIDocument

Variables​

COMPONENTS_PREFIX​

const COMPONENTS_PREFIX: "#/components/schemas/" = "#/components/schemas/"

Defined in: schema-converter.ts:14

Where convertSchemaToOpenAPI points a ref node.

Type Aliases​

GenerateOpenAPIOptions​

GenerateOpenAPIOptions = object

Defined in: generator.ts:62

Properties​

info?​

optional info?: object

Defined in: generator.ts:64

description?​

optional description?: string

title?​

optional title?: string

version?​

optional version?: string

outputFile?​

optional outputFile?: string

Defined in: generator.ts:65

tsconfigPath?​

optional tsconfigPath?: string

Defined in: generator.ts:63

OpenAPIComponents​

OpenAPIComponents = object

Defined in: generator.ts:47

Properties​

schemas​

schemas: Record<string, OpenAPISchemaObject>

Defined in: generator.ts:48

OpenAPIDocument​

OpenAPIDocument = object

Defined in: generator.ts:51

Properties​

components?​

optional components?: OpenAPIComponents

Defined in: generator.ts:59

The recursive types, named once and pointed at by $ref. Absent when nothing in the API recurses.

info​

info: OpenAPIInfo

Defined in: generator.ts:53

openapi​

openapi: string

Defined in: generator.ts:52

paths​

paths: Record<string, Record<string, OpenAPIOperation>>

Defined in: generator.ts:54

OpenAPIInfo​

OpenAPIInfo = object

Defined in: generator.ts:11

Properties​

description?​

optional description?: string

Defined in: generator.ts:14

title​

title: string

Defined in: generator.ts:12

version​

version: string

Defined in: generator.ts:13

OpenAPIOperation​

OpenAPIOperation = object

Defined in: generator.ts:33

Properties​

description?​

optional description?: string

Defined in: generator.ts:35

operationId?​

optional operationId?: string

Defined in: generator.ts:34

parameters?​

optional parameters?: OpenAPIParameter[]

Defined in: generator.ts:36

requestBody?​

optional requestBody?: object

Defined in: generator.ts:37

content​

content: object

content.application/json​

application/json: object

content.application/json.schema​

schema: OpenAPISchemaObject

responses​

responses: Record<string, OpenAPIResponse>

Defined in: generator.ts:44

OpenAPIParameter​

OpenAPIParameter = object

Defined in: generator.ts:17

Properties​

in​

in: "path" | "query" | "header"

Defined in: generator.ts:19

name​

name: string

Defined in: generator.ts:18

required​

required: boolean

Defined in: generator.ts:20

schema​

schema: OpenAPISchemaObject

Defined in: generator.ts:21

OpenAPIResponse​

OpenAPIResponse = object

Defined in: generator.ts:24

Properties​

content?​

optional content?: object

Defined in: generator.ts:26

application/json​

application/json: object

application/json.schema​

schema: OpenAPISchemaObject

description​

description: string

Defined in: generator.ts:25

OpenAPISchemaObject​

OpenAPISchemaObject = object

Defined in: schema-converter.ts:3

Properties​

$ref?​

optional $ref?: string

Defined in: schema-converter.ts:10

enum?​

optional enum?: (string | number | boolean)[]

Defined in: schema-converter.ts:5

items?​

optional items?: OpenAPISchemaObject

Defined in: schema-converter.ts:6

oneOf?​

optional oneOf?: OpenAPISchemaObject[]

Defined in: schema-converter.ts:9

properties?​

optional properties?: Record<string, OpenAPISchemaObject>

Defined in: schema-converter.ts:7

required?​

optional required?: string[]

Defined in: schema-converter.ts:8

type?​

optional type?: string

Defined in: schema-converter.ts:4