apiaryio
Apiary.io CLI
Install
install gem (required)
gem install apiaryio
setup APIARY.io credentials (required for publish and fetch command only)
- Retrieve APIKEY on
https://login.apiary.io/tokens
- Save it to your environment variables :
export APIARY_API_KEY=<your_token_retrieved_on_step_1>
Description
Apiaryio gem provides a way to display your API documentation on your local machine, either using static files or using a standalone web server...
Usage
$ apiary help
Usage: apiary command [options]
Try 'apiary help' for more information.
Currently available apiary commands are:
preview Show API documentation in default browser
preview --browser [chrome|safari|firefox] Show API documentation in specified browser
preview --output [FILE] Write generated HTML into specified file
preview --path [PATH] Specify path to blueprint file
preview --api_host [HOST] Specify apiary host
preview --server Start standalone web server on port 8080
preview --server --port [PORT] Start standalone web server on specified port
publish --api-name [API_NAME] Publish apiary.apib on docs.API_NAME.apiary.io
publish --api-name [API_NAME] \
--message [COMMIT_MESSAGE] Publish with custom commit message
fetch --api-name [API_NAME] Fetch apiary.apib from API_NAME.apiary.io
help Show this help
version Show version
Copyright
Copyright 2012-14 (c) Apiary Ltd.
Contributors
- Jakub Nešetřil
- James Charles Russell [botanicus]
- Lukáš Linhart [Almad]
- Emili Parreño
- Peter Grilli [Tu1ly]
- Ladislav Prskavec
- Honza Javorek
- Matthew Rudy Jacobs
- Adam Kliment
- Jack Repenning
- Peter Strapp
- Pierre Merlin
- František Hába
- Benjamin Arthur Lupton
License
Released under MIT license. See LICENSE file for further details.