REST API与koa2。多个路由器的公共前缀

时间:2016-02-09 21:30:18

标签: koa koa-router koa2

我有两个实体,用户和员工。所以我想在不同的端点都使用CRUD,但是它们都将安装在“api”下,所以我可以定义api_v1,api_v2等等。 端点类似于:

get api/users
put api/users/12
delete api/users/12
get api/employees
....

我的两条路线都无法获得“api”前缀。无法使用koa-mount。

我的档案:

server.js

// Dependencies
import Koa from 'koa'
import mongoose from 'mongoose'
import logger from 'koa-logger'
// import parser from 'koa-bodyparser';
import convert from 'koa-convert'
import serve from 'koa-static'
import Router from 'koa-router'
import session from 'koa-generic-session'
import mount from 'koa-mount'

// A seperate file with my routes.
import routingUsers from './users'
import routingEmployees from './employees'

// config
const config = require("./config/config")

// connect to the database
mongoose.connect(config.mongo.url)
mongoose.connection.on('error', console.error)

// Creates the application.
const app = new Koa()
// how to use koa-mount to make this work? Arghhhhh!
// const api = new Koa();
// api.use(convert(mount ('/api', app)))

// trust proxy
app.proxy = true
// sessions
app.keys = ['your-session-secret']


// Applies all routes to the router.
const user = routingUsers(Router())
const employee = routingEmployees(Router())

app
  .use(logger()) // log requests, should be at the beginning
  .use(user.routes()) // asign routes
  .use(employee.routes()) // asign routes
  .use(user.allowedMethods())
  .use(employee.allowedMethods())
  .use(convert(session())) // session not needed for an API??????
  .use(convert(serve(__dirname + '/public')))   // for static files like images


// Start the application.
app.listen(3000, () => console.log('server started 3000'))
export default app

users.js (employees.js是相同的)

// Export a function that takes the router
export default router => {
  // Set a prefix of our api, in this case locations
  const api = 'users'
  router.prefix(`/${api}`);

  // GET to all locations.
  router.get('/',  (ctx, next) =>
      ctx.body = 'hello users');
    // ctx.body = await Location.find());
  // POST a new location.
  router.post('/', async (ctx, next) =>
    ctx.body = await new Location(ctx.request.body).save());
  // Routes to /locations/id.
  router.get('/:id', async (ctx, next) =>
    ctx.body = await Location.findById(ctx.params.id));
  // PUT to a single location.
  router.put('/:id', async (ctx, next) =>
    ctx.body = await Location.findByIdAndUpdate(ctx.params.id, ctx.body));
  // DELETE to a single location.
  router.delete('/:id', async (ctx, next) =>
    ctx.body = await Location.findByIdAndRemove(ctx.params.id));

  return router;
}

2 个答案:

答案 0 :(得分:1)

最后我已经向路由器模块发送了另一个参数,所以我使用了路由器前缀:

// Applies all routes to the router.
const user = routingUsers(Router(), 'api/users/')
const employee = routingEmployees(Router(), 'api/employees/')

用户将是:

export default (router, prefix) => {
  // Set a prefix of our api, in this case locations
  // const api = 'users'
  router.prefix(`/${prefix}`);
 ....

答案 1 :(得分:1)

我使用以下解决方案:

import Router from 'koa-router';

const router = new Router()
  .get('/', function(ctx) {
    ctx.body = 'Index';
  });


const apiRouter = new Router({
  prefix: '/api'
})
  .get('/templates', Templates.index)
  .post('/templates', Templates.store)
  .put('/templates', Templates.update)
  .get('/lists', Lists.index);


router.use(apiRouter.routes());