https://github.com/zonkyio/zonky-api
Zonky API
https://github.com/zonkyio/zonky-api
apiary zonky-api
Last synced: about 1 year ago
JSON representation
Zonky API
- Host: GitHub
- URL: https://github.com/zonkyio/zonky-api
- Owner: zonkyio
- Created: 2016-05-10T11:49:09.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2022-01-04T08:45:46.000Z (over 4 years ago)
- Last Synced: 2025-01-25T17:10:01.345Z (over 1 year ago)
- Topics: apiary, zonky-api
- Language: API Blueprint
- Size: 170 KB
- Stars: 9
- Watchers: 14
- Forks: 15
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Zonky REST API
This is repository for Zonky REST API documentation. The latest version of the documentation is also publicly available on Apiary (http://docs.zonky.apiary.io).
## Local development
You can build and export the documentation locally outside Apiary with a few simple steps. All you need is working Node.js environment on your machine.
1. Clone this repository
```bash
git clone git@github.com:zonkyio/zonky-api.git
cd zonky-api
```
2. Install project dependencies
```bash
npm install
```
3. Run development server
```bash
npm run dev
```
Server will start on `http://localhost:3000` and will listen for changes in `apiary.apib` file.
4. Export documentation
```bash
npm run build
```
The documentation will be exported to a single `output.html` file