https://github.com/koajs/resourcer-docs
[MAINTAINERS WANTED] Simple app that generates documentation for routes mounted using koa-resourcer.
https://github.com/koajs/resourcer-docs
Last synced: 18 days ago
JSON representation
[MAINTAINERS WANTED] Simple app that generates documentation for routes mounted using koa-resourcer.
- Host: GitHub
- URL: https://github.com/koajs/resourcer-docs
- Owner: koajs
- License: mit
- Created: 2014-10-02T21:50:22.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-09-15T21:53:34.000Z (about 1 year ago)
- Last Synced: 2024-10-29T15:32:19.588Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 34.2 KB
- Stars: 6
- Watchers: 40
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
- awesome-koa - resourcer-docs - Simple app that generates documentation for routes mounted using koa-resourcer. (Middleware)
README
#resourcer-docs
A simple documentation generator for [koa-resourcer](https://github.com/koajs/resourcer).
## Use
In your app:
```js
var koa = require('koa');
var join = require('path').join;
var resource = require('koa-resourcer');
var docs = require('koa-resourcer-docs');
var app = koa();
resource(app, join(__dirname, 'resources'), docs.addRoute);
app.listen();
```
In each resource app:
```js
var koa = require('koa');
var Router = require('koa-joi-router');
var router = Router();
var app = module.exports = koa();
// Expose routes to documentation generator
app.routes = router.routes;
// Define some routes...
app.use(router.middleware());
```
## Configuration
Add a description to the route config:
```js
router.get('/', {meta: {description: 'Home page'}}, function* () {
this.body = "Home page under construction since 2009";
});
```
Hide a resource by not exposing routes:
```js
// Expose routes to documentation generator
//app.routes = router.routes;
```
Hide individual routes in a resource app from documentation by adding `hide: true` to route metadata:
```js
// Documented route:
router.get('/', {meta: {description: 'Main route'}}, function* () {
this.body = 'Hello world';
});
// Hidden route:
router.get('/secretRoute', {meta: {description: 'Nobody here but us chickens.', hide: true}}, function* () {
this.body = 'This is a hidden world';
});
```
Add middleware to intercept requests before routing to docs:
```js
var docs = require('koa-resourcer-docs');
// Respond with 404 if not in a development environment
docs.useRequestHandler(function* (next) {
if (process.env.NODE_ENV === 'development') {
return yield next;
}
this.throw(404);
});
```
For backwards compatibility "hide" and "description" on the koa-joi-router configuration object are still supported but **no longer recommended** since they pollute the namespace of the configuration.
## Installation
```
npm install koa-resourcer-docs --save
```
## Sponsored by
[Pebble Technology!](https://www.pebble.com)
## LICENSE
[MIT](/LICENSE)