https://github.com/mathiconical/learning-api-blueprint
Repository to learn about api blueprint, aglio, drakov and dredd.
https://github.com/mathiconical/learning-api-blueprint
Last synced: 5 months ago
JSON representation
Repository to learn about api blueprint, aglio, drakov and dredd.
- Host: GitHub
- URL: https://github.com/mathiconical/learning-api-blueprint
- Owner: mathiconical
- License: mit
- Created: 2022-11-05T12:58:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-06T01:13:35.000Z (over 3 years ago)
- Last Synced: 2025-07-07T07:48:45.945Z (12 months ago)
- Language: HTML
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Learning API Blueprint
Repository to learn about api blueprint, aglio, drakov and dredd.
***
TODO
- [x] Actions
- [ ] Waypoints
- [x] Functions
***
#### Install Aglio to create, edit and generate API Documentation
> npm install -g aglio
##### Generate Index.html API Documentation
> aglio -i example.apib --theme-full-width --no-theme-condense -o index.html
##### Generate a dynamic API Documentation in 127.0.0.1 in port 3000 ( 127.0.0.1:3000 ) with auto refreshing.
> aglio -i example.apib --theme-full-width --no-theme-condense -s
***
#### Install Drakov to create a MOCK SERVER from routes of the API Documentation
> npm install -g drakov
##### Runs Drakov to create a MOCK SERVER in port 4000 ( not able auto refreshing )
> drakov -f example.apib -p 4000
***
#### Install Dredd to runs route tests.
> npm install -g dredd
##### Runs Dredd to execute tests in routes.
> dredd example.apib http://localhost:4000/
***
#### Template that I used to generate my index.html
See more examples on aglio github repository
> aglio -i example.apib --theme-full-width -t cyborg -o index.html