https://github.com/azhirov/openapi-3.0-types
This package provides TypeScript types for OpenAPI 3.0
https://github.com/azhirov/openapi-3.0-types
openapi openapi3 types
Last synced: 10 months ago
JSON representation
This package provides TypeScript types for OpenAPI 3.0
- Host: GitHub
- URL: https://github.com/azhirov/openapi-3.0-types
- Owner: azhirov
- License: mit
- Created: 2023-04-16T13:59:06.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-17T01:14:41.000Z (almost 3 years ago)
- Last Synced: 2025-03-18T00:12:29.422Z (11 months ago)
- Topics: openapi, openapi3, types
- Language: TypeScript
- Homepage:
- Size: 149 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenAPI Types
This package provides TypeScript types for OpenAPI 3.0, based on the official [OpenAPI Specification 3.0.3](https://spec.openapis.org/oas/v3.0.3). These types allow you to validate and type-check your OpenAPI documents in TypeScript, providing improved documentation and confidence in your API contracts.
## Installation
```
npm i --save-dev openapi-3.0-types
```
## Usage
To use the OpenAPI types in your TypeScript project, simply import them as needed:
```typescript
import type { OpenApiObject3 } from 'openapi-3.0-types';
const myApiSpec: OpenApiObject3 = {
// ...
};
```
The OpenApiObject3 type represents the root object of an OpenAPI specification. Other types are provided for each component of the specification, such as PathItemObject3, ParameterObject3, and ResponseObject3.
For more information on the available types, please refer to the official [OpenAPI Specification 3.0.3](https://spec.openapis.org/oas/v3.0.3).
## Generate `*.d.ts`
1. Clone this repository
2. Install typescript
3. Run `tsc`
## Contributing
If you find a bug or would like to contribute to the package, please feel free to open an issue or submit a pull request on the GitHub repository.
## License
This package is licensed under the MIT License. See the LICENSE file for details.