ホームページ > 記事 > ウェブフロントエンド > Koa で応答を送信する簡単な方法

Koa で応答を送信する簡単な方法

不言オリジナル: 2018-07-21 11:26:441908ブラウズ

この記事では、Koa で返信を送信する簡単な方法を紹介します。困っている友達が参考になれば幸いです。

バックグラウンド

最近、私は多くのノードバックエンドプロジェクトを実行し、多くのインターフェイスを作成しましたが、インターフェイスの数が徐々に増加するにつれて、次のようなコードをどんどん書く必要があることがわかりました。

ctx.body = {
    data: {
        name: 'test'
    },
    status: {
        code: 0,
        message: success
    }
}

このように書いても大丈夫ですが、少なくともすべてのインターフェースが返す形式は統一されています。この点で標準化がなければ、バックエンドインターフェースの戻り値が統一されず、多くの問題が表面化します。終わり。

そして、各インターフェイスには大量のコードを記述する必要があります。特に面倒な事のように感じます。

そこで koa2-response が誕生しました。実際、この記事を書く前から、私はプロジェクトでこれをしばらく使用しており、そのおかげで作業が容易になりました。

インストール

npm install koa2-response

使用法

const koa = require('koa');
const router = require('koa-router')();
const app = new koa();
const response = require('koa2-response');

const code = {
  UNKNOWN_ERROR: [1, 'Sorry, you seem to have encountered some unknown errors.']
}

router
  .get('/', (ctx, next) => {
    response.success(ctx, {
      name: 'test'
    })
  })
  .get('/error_test', (ctx, next) => {
    response.error(ctx, code.UNKNOWN_ERROR);
  })

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

app.listen(3000);

この方法により、プロジェクトにかかる時間を大幅に節約できました。このミドルウェアは現在も継続的に更新されており、既存のメソッドはresponse.successとresponse.errorです。私は引き続き、response.throw というメソッドを更新する予定です。これにより、返される http ステータスコードとエラーメッセージをバックグラウンドでカスタマイズできるようになります。たとえば、ユーザーに権限がない場合、http ステータスコードはカスタムコードではなく 401 である必要があります。

Koa で応答を送信する簡単な方法

関連記事