TypeScript library to help building OpenAPI 3.x compliant API contracts.

Breaking change notice:

Version 4.0 Adds explicit support for OAS 3.0 and OAS 3.1 as separate implementations.

From Typescript you can consume it from the library:

import { oas31 } from "openapi3-ts";

Or directly from sources:

import { OpenAPIObject } from "openapi3-ts/src/model/openapi31";
import { OpenApiBuilder } from "openapi3-ts/src/dsl/openapi-builder31";

From a JavaScript application you can import:

import { oas31 } from 'openapi3-ts';

From Typescript you can consume it from the library:

import { oas30 } from "openapi3-ts";

Or directly from the sources:

import { OpenAPIObject } from "openapi3-ts/src/model/openapi30";
import { OpenApiBuilder } from "openapi3-ts/src/dsl/openapi-builder30";

From a JavaScript application you can import:

import { oas30 } from "openapi3-ts";

• /src/model TS typed interfaces for helping building a contract.
• /src/dsl Fluent DSL for building a contract.

Install package via npm:

npm i --save openapi3-ts

See changelog.

• OpenAPI spec 3.1.0. https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md

Licensed under the MIT License.

Contact: Pedro J. Molina | github: pjmolina | twitter: pmolinam

(c) 2017-2023. Pedro J. Molina at Metadev S.L. https://metadev.pro & contributors.