https://github.com/jimschubert/simple-petstore
https://github.com/jimschubert/simple-petstore
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jimschubert/simple-petstore
- Owner: jimschubert
- License: apache-2.0
- Created: 2017-06-04T14:15:32.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-12-08T04:59:07.000Z (over 8 years ago)
- Last Synced: 2025-06-03T00:04:45.903Z (about 1 year ago)
- Language: HTML
- Size: 494 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# simple petstore
A simple json-backed REST API similar to Swagger's Petstore API.
This example uses [json-server](https://github.com/typicode/json-server) to quickly create a usable API from a structured file-based JSON database.
# Requirements
* Node.js 8.0 or higher
* Yarn 0.24.6 or higher
# Running
To run the pure json-server frontend on top of `db.json`, just run:
```
yarn start
```
This doesn't include any of the additional endpoints or customizations for testing more complex Swagger capabilities.
To run a server with the more complex functionality, run:
```
yarn run simple
```
This includes Swagger UI at the served index to get a feel for the API's functionality. This also helps if you're not that familiar with json-server.