@acathur/koa-decorator-ts 中文文档教程
koa-decorator-ts
这个模块是 koa-decorator-ts 的一个分支,为所有标准的 HTTP 方法提供装饰器: @Get()
, @Post()
, @Put()
, @Delete()
, @Patch()
、@Options()
和 @Head()
。 此外,@All()
定义了一个处理所有这些的端点。
Koa Decorator (with TypeScript)
Installation
npm i koa-decorator-ts --save
/* or */
yarn add koa-decorator-ts
Introduction
这个包是 koa 的装饰器,包括 koa-router,graohql。 您可以使用装饰器来定义路由路径或使用现有的 koa 控制器
Usage
app.js
import Koa from 'koa';
// 1. Import Router
import Router from 'koa-decorator-ts/router';
const app = new Koa();
// 2. Create router
const router = new Router({
dir: `${__dirname}/controllers` // The controllers directory
});
// [Optional] Graphql inital
const graphqlServer = new ApolloServer({ schema });
graphqlServer.applyMiddleware({ app });
// 3. Register the routers
app.use(router.routes());
app.use(router.allowedMethods());
...
app.listen(8080);
/controllers/user.ts创建 graphql 解析器
import Koa from 'koa';
import {
Controller,
Route,
All,
Post,
Get,
Patch,
Put,
Delete,
Middleware,
Required,
Graphql,
Priority,
Meta,
} from 'koa-decorator-ts';
import { IsString } from 'class-validator';
async function middlewareLog(ctx: Koa.Context, next: Function) {
await next();
}
//use a class with decorators (class-validator) for validation
class PatchUserRequest{
@IsString()
userNickName!:string
@IsString()
userAddress!:string
}
// Prefix of api path
@Controller('/user')
class UserController {
@Priority(-1000)
@All('*')
async handleAll(ctx: Koa.Context, next: any) {
ctx.body = 'haha';
}
// Post /user/login
@Post('/login')
@Required({
// Require { userEmail, password } in the body
body: {
type: 'object',
properties: {
userEmail: {
type: 'string',
},
password: {
type: 'string',
},
},
required: ['userEmail', 'password'],
},
})
async login(ctx: Koa.Context) {
ctx.body = true;
}
// Get /user/:userId
@Get('/:userId')
@Middleware(middlewareLog) // Add Middleware
async getUserInfo(ctx: Koa.Context) {
ctx.body = { userName: 'skm', userEmail: 'skmdev@gmail.com' };
}
// Get /user?top=10&star=1000000
@Get('/')
@Required({
query: {
type: 'object',
properties: {
top: { type: 'string' },
star: { type: 'string' },
},
required: ['top', 'star'],
},
}) // Require for "top", "star" in the query
@Middleware(middlewareLog)
async getUsers(ctx: Koa.Context) {
ctx.body = { userName: 'skm', userEmail: 'skmdev@gmail.com' };
}
// Patch /user/:userId
@Patch('/:userId')
@RequiredBody(PatchUserRequest) //do the same for query using @RequiredQuery
async updateUserInfo(ctx: Koa.Context) {
ctx.body = true;
}
// Put /user/:userId/follow
@Put('/:userId/follow')
async followUser(ctx: Koa.Context) {
ctx.body = true;
}
// Delete /user/:userId/follow
@Delete('/:userId/follow')
async unfollowUser(ctx: Koa.Context) {
ctx.body = true;
}
@Meta({ test: 'cc' })
@Get('/meta')
async metaTest(ctx: Koa.Context) {
ctx.body = ctx.meta;
}
@Graphql
@Middleware(middlewareLog)
static async getUser(ctx: Koa.Context) {
const { args } = ctx.graphql!;
const users = [
{ username: 'skmdev', role: 'admin', userEmail: 'skmdev29@gmail.com' },
{ username: 'foo', role: 'user', userEmail: 'bar' },
];
ctx.body = users.find((user) => user.username === args.username);
}
@Graphql // transfrom to graphql resolver
@Middleware(middlewareLog)
static async getUsersGraph(ctx: Koa.Context) {
/**
* const { root, args, info } = ctx.graphql;
*
* root is representing rootObject
*
* args is representing the arguments of request
*
* info is representing the graphql info
*
*/
const { args } = ctx.graphql!;
const users = [
{ username: 'skmdev', role: 'admin', userEmail: 'skmdev29@gmail.com' },
{ username: 'foo', role: 'user', userEmail: 'bar' },
];
// ctx.body is response data;
ctx.body = users.filter((user) => user.role === args.role);
}
}
export default UserController;
koa-decorator-ts
This module is a fork of koa-decorator-ts, provides decorators for all of the standard HTTP methods: @Get()
, @Post()
, @Put()
, @Delete()
, @Patch()
, @Options()
, and @Head()
. In addition, @All()
defines an endpoint that handles all of them.
Koa Decorator (with TypeScript)
Installation
npm i koa-decorator-ts --save
/* or */
yarn add koa-decorator-ts
Introduction
This package is a decorator for koa, including the koa-router, graohql. You can use decorators to define the path of routing or create a graphql resolver using existing koa controller
Usage
app.js
import Koa from 'koa';
// 1. Import Router
import Router from 'koa-decorator-ts/router';
const app = new Koa();
// 2. Create router
const router = new Router({
dir: `${__dirname}/controllers` // The controllers directory
});
// [Optional] Graphql inital
const graphqlServer = new ApolloServer({ schema });
graphqlServer.applyMiddleware({ app });
// 3. Register the routers
app.use(router.routes());
app.use(router.allowedMethods());
...
app.listen(8080);
/controllers/user.ts
import Koa from 'koa';
import {
Controller,
Route,
All,
Post,
Get,
Patch,
Put,
Delete,
Middleware,
Required,
Graphql,
Priority,
Meta,
} from 'koa-decorator-ts';
import { IsString } from 'class-validator';
async function middlewareLog(ctx: Koa.Context, next: Function) {
await next();
}
//use a class with decorators (class-validator) for validation
class PatchUserRequest{
@IsString()
userNickName!:string
@IsString()
userAddress!:string
}
// Prefix of api path
@Controller('/user')
class UserController {
@Priority(-1000)
@All('*')
async handleAll(ctx: Koa.Context, next: any) {
ctx.body = 'haha';
}
// Post /user/login
@Post('/login')
@Required({
// Require { userEmail, password } in the body
body: {
type: 'object',
properties: {
userEmail: {
type: 'string',
},
password: {
type: 'string',
},
},
required: ['userEmail', 'password'],
},
})
async login(ctx: Koa.Context) {
ctx.body = true;
}
// Get /user/:userId
@Get('/:userId')
@Middleware(middlewareLog) // Add Middleware
async getUserInfo(ctx: Koa.Context) {
ctx.body = { userName: 'skm', userEmail: 'skmdev@gmail.com' };
}
// Get /user?top=10&star=1000000
@Get('/')
@Required({
query: {
type: 'object',
properties: {
top: { type: 'string' },
star: { type: 'string' },
},
required: ['top', 'star'],
},
}) // Require for "top", "star" in the query
@Middleware(middlewareLog)
async getUsers(ctx: Koa.Context) {
ctx.body = { userName: 'skm', userEmail: 'skmdev@gmail.com' };
}
// Patch /user/:userId
@Patch('/:userId')
@RequiredBody(PatchUserRequest) //do the same for query using @RequiredQuery
async updateUserInfo(ctx: Koa.Context) {
ctx.body = true;
}
// Put /user/:userId/follow
@Put('/:userId/follow')
async followUser(ctx: Koa.Context) {
ctx.body = true;
}
// Delete /user/:userId/follow
@Delete('/:userId/follow')
async unfollowUser(ctx: Koa.Context) {
ctx.body = true;
}
@Meta({ test: 'cc' })
@Get('/meta')
async metaTest(ctx: Koa.Context) {
ctx.body = ctx.meta;
}
@Graphql
@Middleware(middlewareLog)
static async getUser(ctx: Koa.Context) {
const { args } = ctx.graphql!;
const users = [
{ username: 'skmdev', role: 'admin', userEmail: 'skmdev29@gmail.com' },
{ username: 'foo', role: 'user', userEmail: 'bar' },
];
ctx.body = users.find((user) => user.username === args.username);
}
@Graphql // transfrom to graphql resolver
@Middleware(middlewareLog)
static async getUsersGraph(ctx: Koa.Context) {
/**
* const { root, args, info } = ctx.graphql;
*
* root is representing rootObject
*
* args is representing the arguments of request
*
* info is representing the graphql info
*
*/
const { args } = ctx.graphql!;
const users = [
{ username: 'skmdev', role: 'admin', userEmail: 'skmdev29@gmail.com' },
{ username: 'foo', role: 'user', userEmail: 'bar' },
];
// ctx.body is response data;
ctx.body = users.filter((user) => user.role === args.role);
}
}
export default UserController;