https://github.com/readmeio/oas-examples

A collection of example OpenAPI 3.x and Swagger 2.0 documents.
https://github.com/readmeio/oas-examples

openapi swagger

Last synced: 11 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/readmeio/oas-examples
• Owner: readmeio
• License: mit
• Created: 2020-10-19T22:39:27.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-03-02T01:03:58.000Z (11 months ago)
• Last Synced: 2025-03-03T01:13:04.119Z (11 months ago)
• Topics: openapi, swagger
• Language: TypeScript
• Homepage:
• Size: 1.29 MB
• Stars: 23
• Watchers: 15
• Forks: 27
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
> [!IMPORTANT]  

> `@readme/oas-examples` has moved! The source for this library now lives at https://github.com/readmeio/oas.

# @readme/oas-examples

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

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

[![](https://raw.githubusercontent.com/readmeio/.github/main/oss-header.png)](https://readme.io)

## Installation

```sh

npm install --save @readme/oas-examples

```

## Usage

```js

const definition = require('@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.