# @readme/oas-examples

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

Latest version **8.2.2** (published 2026-06-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @readme/oas-examples
pnpm add @readme/oas-examples
yarn add @readme/oas-examples
bun add @readme/oas-examples
```

## Health

**Score 50/100 (C)** — status: active.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 8.2.2 |
| Published | 2026-06-25 |
| First published | 2020-02-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 401 |
| Author | ReadMe |
| Maintainers | gkoberger, domharrington, mjcuva, jonursenbach, rafegoldberg, darrenyong |
| Keywords | openapi initiative, openapi spec, openapi document, oai, oas |

## Links

- npm: https://www.npmjs.com/package/@readme/oas-examples
- Repository: https://github.com/readmeio/oas
- Homepage: https://github.com/readmeio/oas#readme
- Issues: https://github.com/readmeio/oas/issues
- npm.io page: https://npm.io/package/@readme/oas-examples

## Alternatives

- [update-check](https://npm.io/package/update-check.md) — 4.0M weekly downloads
- [react-native-onesignal](https://npm.io/package/react-native-onesignal.md) — 134.5K weekly downloads
- [react-redux-toastr](https://npm.io/package/react-redux-toastr.md) — 33.7K weekly downloads
- [@nocobase/plugin-notification-manager](https://npm.io/package/@nocobase/plugin-notification-manager.md) — 2.0K weekly downloads
- [react-simple-toasts](https://npm.io/package/react-simple-toasts.md) — 1.9K weekly downloads

## Recent versions

- 8.2.2 (latest) — 2026-06-25
- 8.2.1 — 2026-04-02
- 8.2.0 — 2026-03-31
- 8.1.1 — 2026-03-03
- 8.0.0 — 2026-03-02
- 7.2.1 — 2026-01-08
- 7.2.0 — 2025-12-18
- 7.1.2 — 2025-12-16
- 7.1.1 — 2025-12-12
- 7.1.0 — 2025-12-12
- 7.0.4 — 2025-11-11
- 7.0.3 — 2025-10-29
- 7.0.2 — 2025-10-28
- 7.0.1 — 2025-10-06
- 7.0.0 — 2025-08-04
- … 57 more at https://npm.io/package/@readme/oas-examples/versions

## README

# @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.

---
_Source: https://npm.io/package/@readme/oas-examples · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
