讓我們來重新設計一下 koa-router

DataPipeline 發布于2019-08-26 13:32 / 2105人閱讀

摘要：前言是目前用的比較多的的路由中間件之一，前段時間由于作者沒有精力繼續維護而將其公開售賣。我們有些項目也用到了這個庫，但是目前很多我們想要的特性都沒有，比如生成接口文檔。本身這個庫代碼實現還比較簡單，因此綜合考慮打算重寫一個。

前言

koa-router 是目前用的比較多的 Koa 的路由中間件之一，前段時間由于作者沒有精力繼續維護而將其公開售賣。我們有些項目也用到了這個庫，但是目前很多我們想要的特性都沒有，比如生成接口文檔。本身這個庫代碼實現還比較簡單，因此綜合考慮打算重寫一個。

項目地址：https://github.com/d-band/koa...

特性：

支持幾乎所有的 koa-router 特性

支持 params 校驗

params 支持從 path, header, query, cookie 中獲取

支持 body parser

支持 request body 校驗

支持參數類型自動轉換

支持自動生成 OpenAPI

簡單例子：

index.js

import Koa from "koa";
import Mapper from "koa-mapper";
import * as service from "./service";

const Mapper = new Mapper();

mapper.get("/users/:id/projects", {
  params: {
    id: { type: "number" },
    status: { type: "array", in: "query" },
    token: { type: "string", in: "header" }
  }
}, service.getProjects);

mapper.post("/users/:id/projects", {
  params: {
    id: { type: "number" }
  },
  body: "Project"
}, service.addProject);

mapper.schema("Project", {
  id: { type: "number", required: true },
  name: { type: "string", required: true },
  status: { type: "array", required: true }
});

mapper.schema("Status", {
  id: { type: "integer" },
  name: { type: "string" }
}, {
  required: ["id", "name"]
});

app.use(mapper.routes());
app.use(mapper.allowedMethods());

app.listen(3000);

// open http://localhost:3000/openapi.json

service.js

export async function getProjects(ctx) {
  const { id, status, token } = ctx.params;

  await checkToken(id, token);

  ctx.body = await Project.findAll({
    where: {
      userId: id,
      status: { $in: status }
    }
  });
}

export async function addProject(ctx) {
  const { body } = ctx.request;

  ctx.body = await Project.create({
    ...body,
    userId: id
  });
}

路由定義：

mapper.get(path, [options], ...middlewares);
mapper.post(path, [options], ...middlewares);
mapper.put(path, [options], ...middlewares);
mapper.del(path, [options], ...middlewares);
...

options 為可選參數，包含:

name: 路由名稱

params: 請求參數定義

body: 請求 Body 定義

其他 OpenAPI 中 Operation Object 的參數

options.params 為請求參數定義，如：

params = {
  id: { type: "number" },
  name: { type: "string", in: "query" },
  user: { type: "User", in: "query" }
}

type: 參數類型，包含基本類型（number、string、integer、date、time、datetime），數組類型（array），自定義類型（如 User），自定義數組類型（array），多個類型（number|string）

in: 參數來源，包含 path，header，query，cookie

其他 OpenAPI 中 Parameter Object 的參數

自定義類型

mapper.define(schemaName, properties, options);
// or
mapper.schema(schemaName, properties, options);

支持類型組合，如：

mapper.schema("Status", {
  id: { type: "integer" },
  name: { type: "string" }
}, {
  required: ["id"]
});
mapper.schema("Project", {
  id: { type: "number", required: true },
  name: { type: "string", required: true },
  status: { type: "array", required: true }
});

支持繼承，如：

mapper.schema("Model", {
  id: { type: "number" },
  createdAt: { type: "datetime" },
  updatedAt: { type: "datetime" }
});
mapper.schema("User: Model", {
  name: { type: "string" }
});

Body Parser

mapper.post("/users", {
  body: "User"
}, (ctx) => {
  const { id, name } = ctx.request.body;
});

支持文件上傳，如：

mapper.post("/uploadImage", {
  bodyparser: { multipart: true },
  body: {
    user: { type: "number" },
    image: { type: "file" }
  }
}, (ctx) => {
  const { user, image } = ctx.request.body;
});

結尾

目前 koa-mapper 剛發布，測試覆蓋率達到 100%，有哪些有興趣的小伙伴歡迎一起維護。

云服務器 GPU云服務器重新安裝一下java 讓我們一起我們可以用vps來干什么 koa-router

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/109005.html

從零搭建Koa2 Server

摘要：于是翻遍與各大網站，都沒找到一個好用的輕一點的腳手架，也找不到一個清晰些的搭建介紹。現在把搭建過程介紹下，看能不能方便下入門的同學。創建一個文件夾，命名。記得先裝好以上版本一路回車，根據提示輸入信息。但這只是初步的搭建了下。前幾天想寫個小爬蟲程序，準備后端就用koa2。于是翻遍github與各大網站，都沒找到一個好用的、輕一點的koa2腳手架，也找不到一個清晰些的搭建介紹。githu...

JellyBool 2019-08-21 15:49 評論0 收藏0
GraphQL 搭配 Koa 最佳入門實踐

摘要：如下圖嗯，如圖都已經查詢到我們保存的全部數據，并且全部返回前端了。如圖沒錯，什么都沒有就是查詢服務的界面。寫好了之后我們在配置一下路由，進入里面，加入下面幾行代碼。 GraphQL一種用為你 API 而生的查詢語言，2018已經到來，PWA還沒有大量投入生產應用之中就已經火起來了，GraphQL的應用或許也不會太遠了。前端的發展的最大一個特點就是變化快，有時候應對各種需求場景的變化，不...

MoAir 2019-08-21 18:39 評論0 收藏0
不到300行代碼構建精簡的koa和koa-router(mini-koa)

摘要：詳細代碼如下追蹤賦值里面的是子路由設計子路由設計這個比較簡單，每個子路由維護一個路由監聽列表，然后通過調用的函數添加到主路由列表上。 showImg(https://segmentfault.com/img/bVbruD0?w=756&h=378); 前言鑒于之前使用express和koa的經驗，這兩天想嘗試構建出一個koa精簡版，利用最少的代碼實現koa和koa-router，同時...

tuomao 2019-08-23 16:59 評論0 收藏0
Koa v2.x 中文文檔 Koa 對比 Express

摘要：使用承諾和異步功能來擺脫回調地獄的應用程序，并簡化錯誤處理。它暴露了自己的和對象，而不是的和對象。因此，可被視為的模塊的抽象，其中是的應用程序框架。這使得中間件對于整個堆棧而言不僅僅是最終應用程序代碼，而且更易于書寫，并更不容易出錯。 Koa 與 Express 此系列文章的應用示例已發布于 GitHub: koa-docs-Zh-CN. 可以 Fork 幫助改進或 Star 關注更新...

summerpxy 2019-08-21 17:24 評論0 收藏0