https://github.com/fosfad/openapi-typescript-definitions

Types and interfaces for writing valid OpenAPI specification in TypeScript.
https://github.com/fosfad/openapi-typescript-definitions

openapi typescript-types

Last synced: about 2 months ago
JSON representation

Types and interfaces for writing valid OpenAPI specification in TypeScript.

• Host: GitHub
• URL: https://github.com/fosfad/openapi-typescript-definitions
• Owner: fosfad
• License: mit
• Created: 2021-06-25T11:19:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-01T22:21:18.000Z (almost 2 years ago)
• Last Synced: 2024-03-14T19:54:05.893Z (10 months ago)
• Topics: openapi, typescript-types
• Language: TypeScript
• Homepage:
• Size: 355 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OpenAPI TypeScript definitions

This package contains TypeScript definitions for OpenAPI. It may be useful in all kind of TypeScript projects that work with OpenAPI directly, for example, in code generators, in documentation generators and other kinds of projects.

Supported OpenAPI versions:

- [3.1.0](https://spec.openapis.org/oas/v3.1.0)

Since OpenAPI specification relies on JSON Schema specification, this package also has [@fosfad/json-schema-typescript-definitions](https://github.com/fosfad/json-schema-typescript-definitions) package in its dependencies which provides type definitions for JSON Schema.

## Getting started

Install the definitions:

```bash

npm install @fosfad/openapi-typescript-definitions

```

Import `OpenAPI` (and other needed types):

```typescript

import { OpenAPI } from '@fosfad/openapi-typescript-definitions/3.1.0';

```