OpenApi3-TS

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

Version 4

Breaking change notice:

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

To use version 3.1 import

1import { oas31 } from '@a-2-c-2-anpm/occaecati-omnis-dicta';

Or directly import from subpath:

1import { OpenAPIObject, OpenApiBuilder } from '@a-2-c-2-anpm/occaecati-omnis-dicta/oas31';

To use version 3.0 import

1import { oas30 } from '@a-2-c-2-anpm/occaecati-omnis-dicta';

Or directly import from subpath:

1import { OpenAPIObject, OpenApiBuilder } from '@a-2-c-2-anpm/occaecati-omnis-dicta/oas30';

Includes

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

Install

Install package via npm:

1npm i --save @a-2-c-2-anpm/occaecati-omnis-dicta

Versions and Changelog

See changelog.

References

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

License

Licensed under the MIT License.

Credits

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

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