oas30 | webapi-parser

BETA! Provides methods for OAS 3.0 processing

Hierarchy

oas30

Index

Methods

Static generateFile

generateFile(model: WebApiBaseUnit, url: string): Promise<void>

- Defined in webapi-parser.d.ts:340
BETA! Generates file with OAS 3.0 JSON content.

Parameters
- model: WebApiBaseUnit
  
  Parsed WebApi Model to generate content from.
- url: string
  
  Path to the generated file.
Returns Promise<void>

Static generateString

generateString(model: WebApiBaseUnit): Promise<string>

- Defined in webapi-parser.d.ts:347
BETA! Generates string with OAS 3.0 JSON content.

Parameters
- model: WebApiBaseUnit
  
  Parsed WebApi Model to generate content from.
Returns Promise<string>

Generated string.

Static generateYamlFile

generateYamlFile(model: WebApiBaseUnit, url: string): Promise<void>

- Defined in webapi-parser.d.ts:386
BETA! Generates file with OAS 3.0 YAML content.

Parameters
- model: WebApiBaseUnit
  
  Parsed WebApi Model to generate content from.
- url: string
  
  Path to the generated file.
Returns Promise<void>

Static generateYamlString

generateYamlString(model: WebApiBaseUnit): Promise<string>

- Defined in webapi-parser.d.ts:393
BETA! Generates string with OAS 3.0 YAML content.

Parameters
- model: WebApiBaseUnit
  
  Parsed WebApi Model to generate content from.
Returns Promise<string>

Generated string.

Static parse

parse(urlOrContent: string): Promise<WebApiBaseUnit>
parse(content: string, baseUrl: string): Promise<WebApiBaseUnit>

- Defined in webapi-parser.d.ts:324
BETA! Parses OAS 3.0 JSON content from string or url.

Parameters
- urlOrContent: string
  
  File url/path or content string.
Returns Promise<WebApiBaseUnit>

Parsed WebApi Model.
- Defined in webapi-parser.d.ts:333
BETA! Parses OAS 3.0 JSON content from string with a custom API Doc location.

Parameters
- content: string
  
  Content string to be parsed.
- baseUrl: string
  
  Location to assign to a doc parsed from a content string. References are resolved relative to this location.
Returns Promise<WebApiBaseUnit>

Parsed WebApi Model (future).

Static parseYaml

parseYaml(urlOrContent: string): Promise<WebApiBaseUnit>
parseYaml(content: string, baseUrl: string): Promise<WebApiBaseUnit>

- Defined in webapi-parser.d.ts:370
BETA! Parses OAS 3.0 YAML content from string or url.

Parameters
- urlOrContent: string
  
  File url/path or content string.
Returns Promise<WebApiBaseUnit>

Parsed WebApi Model.
- Defined in webapi-parser.d.ts:379
BETA! Parses OAS 3.0 YAML content from string with a custom API Doc location.

Parameters
- content: string
  
  Content string to be parsed.
- baseUrl: string
  
  Location to assign to a doc parsed from a content string. References are resolved relative to this location.
Returns Promise<WebApiBaseUnit>

Parsed WebApi Model (future).

Static resolve

resolve(model: WebApiBaseUnit): Promise<WebApiBaseUnit>

- Defined in webapi-parser.d.ts:363
BETA! Resolves parsed OAS 3.0 model.

Resolution process includes resolving references to all types, libraries, etc.

Parameters
- model: WebApiBaseUnit
  
  Parsed WebApi Model to be resolved.
Returns Promise<WebApiBaseUnit>

Resolved parsed WebApi Model.

Static validate

validate(model: WebApiBaseUnit): Promise<ValidationReport>

- Defined in webapi-parser.d.ts:354
BETA! Validates parsed OAS 3.0 model.

Parameters
- model: WebApiBaseUnit
  
  Parsed WebApi Model to be validated.
Returns Promise<ValidationReport>

Validation report.

Generated using TypeDoc

Hierarchy

Index

Methods

Methods

Static generateFile

Parameters

model: WebApiBaseUnit

url: string

Returns Promise<void>

Static generateString

Parameters

model: WebApiBaseUnit

Returns Promise<string>

Static generateYamlFile

Parameters

model: WebApiBaseUnit

url: string

Returns Promise<void>

Static generateYamlString

Parameters

model: WebApiBaseUnit

Returns Promise<string>

Static parse

Parameters

urlOrContent: string

Returns Promise<WebApiBaseUnit>

Parameters

content: string

baseUrl: string

Returns Promise<WebApiBaseUnit>

Static parseYaml

Parameters

urlOrContent: string

Returns Promise<WebApiBaseUnit>

Parameters

content: string

baseUrl: string

Returns Promise<WebApiBaseUnit>

Static resolve

Parameters

model: WebApiBaseUnit

Returns Promise<WebApiBaseUnit>

Static validate

Parameters

model: WebApiBaseUnit

Returns Promise<ValidationReport>