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: about 1 month 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 (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-24T03:37:41.000Z (about 2 months ago)
• Last Synced: 2024-10-01T00:20:52.880Z (about 1 month ago)
• Topics: openapi, swagger
• Language: JavaScript
• Homepage:
• Size: 1.84 MB
• Stars: 19
• Watchers: 14
• Forks: 24
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

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