# @andoshin11/sample-petstore-api

> A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification

Latest version **0.1.0** (published 2019-12-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @andoshin11/sample-petstore-api
pnpm add @andoshin11/sample-petstore-api
yarn add @andoshin11/sample-petstore-api
bun add @andoshin11/sample-petstore-api
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2019-12-24 |
| First published | 2019-05-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 12.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | andoshin11 |
| Maintainers | andoshin11 |

## Links

- npm: https://www.npmjs.com/package/@andoshin11/sample-petstore-api
- npm.io page: https://npm.io/package/@andoshin11/sample-petstore-api

## Recent versions

- 0.1.0 (latest) — 2019-12-24
- 0.0.1 — 2019-05-05

## README

# Swagger Petstore API Spec

A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification

# Setup
*Node.js v10.15.3 or above is required*

```sh
$ npm install -g yarn
$ yarn install
```

# Update specifications
1. Run `$ docker-compose up -d`
2. Go to http://localhost:3020
3. Edit `src/**/*.yml`

# Build specifications
This repository uses [swagpack](https://www.npmjs.com/package/swagpack) to merge all yaml files referenced by the others into one.

Either by running `$ yarn run build` or just simply by making a new commit to let it happen.

---
_Source: https://npm.io/package/@andoshin11/sample-petstore-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._