Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yujinlim/api-blueprint-cli
This is a cli that extract comment on file for API Blueprint
https://github.com/yujinlim/api-blueprint-cli
Last synced: 15 days ago
JSON representation
This is a cli that extract comment on file for API Blueprint
- Host: GitHub
- URL: https://github.com/yujinlim/api-blueprint-cli
- Owner: yujinlim
- Created: 2016-05-23T13:10:18.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-05-24T03:59:30.000Z (over 8 years ago)
- Last Synced: 2024-12-08T09:04:59.930Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 4.88 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# API Blueprint generator [](https://travis-ci.org/yujinlim/api-blueprint-cli)
> This is a cli that extract comment on file for [API Blueprint](https://apiblueprint.org)
A common use case is to auto generate API documentation and upload to [Apiary](https://apiary.io).
## Installation
``` bash
npm i -g api-blueprint-cli
```
## Usage
``` bash
blueprint --help
# A API blueprint generator from comment
#
# Usage:
# $ blueprint
#
# Options:
# -j, --json Print as JSON API Element
#
# Examples:
# $ blueprint index.js
blueprint routes.js
# FORMAT: 1A
# # My API
# Api
# # Group questions
# Questions related API Points
# ## Question Collection [/questions]
```
## Example
```JS
// routes.js
'use strict';
// FORMAT: 1A
// # My API
// Api
const app = require('koa')();
const router = require('koa-router')();
// # Group questions
// Questions related API Points
// ## Question Collection [/questions]
router.get('/questions', question.get);
```
## Related
- [Apiary](https://apiary.io)
- [API Blueprint](https://apiblueprint.org)
## License
MIT © [Yu Jin Lim](https://github.com/yujinlim)