Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fyl080801/egg-decorator-router
a way, that create route、middleware and others use decorator mode
https://github.com/fyl080801/egg-decorator-router
Last synced: 17 days ago
JSON representation
a way, that create route、middleware and others use decorator mode
- Host: GitHub
- URL: https://github.com/fyl080801/egg-decorator-router
- Owner: fyl080801
- License: mit
- Created: 2019-03-07T10:47:32.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-23T22:23:31.000Z (almost 2 years ago)
- Last Synced: 2024-10-20T15:04:25.679Z (25 days ago)
- Language: JavaScript
- Size: 5.27 MB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# egg-decorator-router
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/egg-decorator-router.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-decorator-router
[travis-image]: https://img.shields.io/travis/fyl080801/egg-decorator-router.svg?style=flat-square
[travis-url]: https://travis-ci.org/fyl080801/egg-decorator-router.svg?branch=master
[codecov-image]: https://img.shields.io/codecov/c/github/fyl080801/egg-decorator-router.svg?style=flat-square
[codecov-url]: https://codecov.io/github/fyl080801/egg-decorator-router?branch=master
[david-image]: https://img.shields.io/david/fyl080801/egg-decorator-router.svg?style=flat-square
[david-url]: https://david-dm.org/fyl080801/egg-decorator-router
[snyk-image]: https://snyk.io/test/npm/egg-decorator-router/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-decorator-router
[download-image]: https://img.shields.io/npm/dm/egg-decorator-router.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-decorator-router
Define egg.js router and middleware use decorator.
## Install
```bash
npm i egg-decorator-router --save
```
## Usage
```js
// {app_root}/config/plugin.js
exports.decoratorRouter = {
enable: true,
package: 'egg-decorator-router'
}
```
> 基于 typescript 的 eggjs 项目可直接使用装饰器
> 如果是 js 项目，则需要手动安装 `babel-plugin-transform-decorators-legacy` 和 `babel-plugin-transform-object-rest-spread`这两个包，并在项目里加入 `.babelrc` 文件
.babelrc 定义如下:
```json
{
"plugins": ["transform-decorators-legacy", "transform-object-rest-spread"]
}
```
## Specification
The full path is combin between root-path and sub-path.
在 controller 中先引入依赖
```javascript
const {
Route,
HttpAll,
HttpGet,
HttpPost,
HttpPut,
HttpPatch,
HttpDelete,
Middleware
} = require('egg-decorator-router')
```
如果使用 typescript
```typescript
import {
Route,
HttpAll,
HttpGet,
HttpPost,
HttpPut,
HttpPatch,
HttpDelete,
Middleware
} from 'egg-decorator-router'
```
### Use Route define a root-path on the controller
Define a root path on controller
```javascript
// root path is '/'
@Route()
// root path is '/'
@Route('/')
// root path is '/routename'
@Route('/routename')
// root path is '/routename/action'
@Route('/routename/action')
```
Parameter is available
```javascript
@Route('/routename/:name')
```
### Use HttpMethod define a sub-path
HttpMethod include `HttpGet` `HttpPost` `HttpPut` `HttpPatch` `HttpDelete` and `HttpAll`
Define a sub-path in controller's method
```javascript
// sub-path is '/'
@HttpGet()
// sub-path is '/'
@HttpGet('/')
// sub-path is '/action'
@HttpGet('/action')
// sub-path is '/action/:id'
@HttpGet('/action/:id')
```
### Define middleware
```javascript
@Middleware(routeM)
```
## Example
```javascript
'use strict'
const { Controller } = require('egg')
const { Route, HttpGet, Middleware, filters } = require('egg-decorator-router')
const { DefaultFilter } = filters
const routeM = (ctx, next) => {
console.log('passed route middleware')
next()
}
const actionM = i => {
return (ctx, next) => {
console.log('passed action middleware ' + i)
next()
}
}
@Route()
@Middleware(routeM)
class HomeController extends Controller {
@HttpGet('/') // path: /
async index() {
await new Promise(resolve => {
this.ctx.body = 'ssss'
resolve()
})
}
@HttpGet() // path: /func1
@Middleware(actionM(2), 2)
@Middleware(actionM(1), 1)
func1(ctx) {
ctx.body = 'hi, func1'
}
@HttpGet(':id') // path: /:id
@DefaultFilter('aaa')
func2(ctx) {
ctx.body = 'hi, func2' + ctx.params.id
}
}
module.exports = HomeController
```
## License
[MIT](LICENSE)