https://github.com/zonkyio/openbanking-api
Zonky Open Banking API
https://github.com/zonkyio/openbanking-api
Last synced: 7 months ago
JSON representation
Zonky Open Banking API
- Host: GitHub
- URL: https://github.com/zonkyio/openbanking-api
- Owner: zonkyio
- Created: 2019-09-03T04:53:21.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-06-12T13:19:08.000Z (over 5 years ago)
- Last Synced: 2025-01-25T17:10:01.412Z (9 months ago)
- Language: API Blueprint
- Size: 7.81 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Zonky Open Banking API
Repository for Zonky Open Banking API documentation. The latest version of the documentation is publicly available on Apiary (https://zonkyopenbanking.docs.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/openbanking-api.git
cd openbanking-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.