@readme/oas-examples/README.md

A collection of example OpenAPI 3.x and Swagger 2.0 documents.

# @readme/oas-examples

A collection of example [OpenAPI 3.x](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md) and [Swagger 2.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md) documents.

[![npm](https://img.shields.io/npm/v/@readme/oas-examples)](https://npm.im/@readme/oas-examples) [![Build](https://github.com/readmeio/oas/workflows/CI/badge.svg)](https://github.com/readmeio/oas/tree/main/packages/oas-examples)

<a href="https://readme.com">
<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/readmeio/.github/main/oss-header-dark.png">
  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/readmeio/.github/main/oss-header.png">
  <img alt="ReadMe Open Source" src="https://raw.githubusercontent.com/readmeio/.github/main/oss-header.png">
</picture>
</a>

## Installation

```sh
npm install --save @readme/oas-examples
```

## Usage

```js
import petstore from '@readme/oas-examples/3.0/json/petstore.json';
```

Check out the `2.0/`, `3.0/`, and `3.1/` directories for the full list of available examples.