https://github.com/nodecloud/koa-route-mapper
koa-routes-map
https://github.com/nodecloud/koa-route-mapper
Last synced: 6 days ago
JSON representation
koa-routes-map
- Host: GitHub
- URL: https://github.com/nodecloud/koa-route-mapper
- Owner: nodecloud
- Created: 2017-11-22T03:06:08.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-23T11:32:42.000Z (about 8 years ago)
- Last Synced: 2025-03-02T05:57:46.348Z (11 months ago)
- Language: JavaScript
- Size: 16.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# koa-route-mapper
This middleware will set a /mappers route as default for getting the URLs.
## Usage
``` javascript
import Koa from 'koa';
import KoaRouter from 'koa-router';
import KoaMapper from 'koa-route-mapper';
let app = new Koa();
const router = new KoaRouter();
app.use(KoaMapper('/mappers', [router]));
```
When visit the /mappers api, it will response:
```json
[
{
"path": "/v1/groups/",
"methods": [
"HEAD",
"GET"
],
"function": [
"getGroups"
]
},
{
"path": "/v1/groups/:groupId/members",
"methods": [
"HEAD",
"GET"
],
"function": [
"getGroupMembers"
]
}
]
```
## API
### KoaMapper(url, routers)
* url default is /metrics.
* routers: array of router instance.