https://github.com/moontai0724/openapi-types

TypeScript types for OpenAPI specification. (v3.1 only now)
https://github.com/moontai0724/openapi-types

openapi specification types typescript

Last synced: 8 months ago
JSON representation

TypeScript types for OpenAPI specification. (v3.1 only now)

• Host: GitHub
• URL: https://github.com/moontai0724/openapi-types
• Owner: moontai0724
• License: mit
• Created: 2024-04-24T09:02:15.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-08T04:08:36.000Z (over 1 year ago)
• Last Synced: 2025-01-31T21:03:30.635Z (9 months ago)
• Topics: openapi, specification, types, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@moontai0724/openapi-types
• Size: 426 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# @moontai0724/openapi-types

[![NPM Version](https://img.shields.io/npm/v/@moontai0724/openapi-types)](https://www.npmjs.com/package/@moontai0724/openapi-types)

[![NPM Downloads](https://img.shields.io/npm/d18m/@moontai0724/openapi-types)](https://www.npmjs.com/package/@moontai0724/openapi-types)

TypeScript types for [OpenAPI](https://www.openapis.org/) specification.

Currently, this package only supports OpenAPI v3.1.

## Install

### NPM

```bash

npm install -D @moontai0724/openapi-types

```

### Yarn

```bash

yarn add -D @moontai0724/openapi-types

```

### PNPM

```bash

pnpm add -D @moontai0724/openapi-types

```

## Usage

```typescript

import type {

  OpenAPIObject,

  OperationObject,

} from "@moontai0724/openapi-types";

const openapi: OpenAPIObject = {

  openapi: "3.0.0",

  // ...

};

const operation: OperationObject = {

  // ...

};

```

## API Document

See the [API documentation](https://moontai0724.github.io/openapi-types/).