web-dev-qa-db-ja.com

SuperAgentが行うすべてのリクエストにカスタムHTTPヘッダーを挿入するにはどうすればよいですか?

明らかに SuperAgent はカスタムHTTPヘッダーをサポートします:

request
   .post('/api/pet')
   .send({ name: 'Manny', species: 'cat' })
   .set('X-API-Key', 'foobar')
   .set('Accept', 'application/json')
   .end(function(err, res){
     if (res.ok) {
       alert('yay got ' + JSON.stringify(res.body));
     } else {
       alert('Oh no! error ' + res.text);
     }
   });

私の質問:

  • SuperAgentをnpmでプルダウンしている場合、SuperAgentが行うすべてのリクエストに自分のHTTPヘッダーを挿入するにはどうすればよいですか?
  • 注:必要に応じて、SuperAgentを拡張する新しいnpmパッケージを作成してもかまいません。
15
Jim G.

私はこのようなもので別のモジュールを作るだけです:

myagent.js

var superagent = require('superagent');

var defaultHeaders = {};
function isObject(obj) { return Object(obj) === obj; };

function request(method, url) {
   return superagent(method, url).set(defaultHeaders);
}

request.set = function (field, value) {
   if (isObject(field)) {
      for(var key in field) this.set(key, field[key]);
      return this;
   }
   defaultHeaders[field] = value;
   return this;
}
module.exports = request;

使用法

var request = require('./myagent');
request.set({'X-My-Header': 'foo'}); // sets the default

request.get('/bar').send() // will send the default header

このモジュールはスーパーエージェントと同じように動作しますが、Requestオブジェクトを返す前にデフォルトのヘッダーを設定します。 こちら を参照

24

これは遅い回答になる可能性がありますが、superagent-useプラグインを使用して、すべてのリクエストにカスタムHTTPヘッダーを挿入しました。まず、superagent-useをインストールする必要があります

npm install superagent-use --save

次に、このように要求します

// using plugin to intercept calls
var request = require('superagent-use')(require('superagent'));

次に、ミドルウェア/インターセプターとして機能を追加します

// interceptor used by superagent to add custom header for each request
request.use((req) => {
    req.header.custom_header = any_value;
    return req;
});

そして最後に

request
    .get(url)
    .query({ view: 'jsonView' }) // query string
6
Sunil Garg

したがって、私の場合、すべてのリクエストでデフォルトのヘッダーとしてcsrfトークンを設定する必要がありました。このような単純なラッパー関数を書くことができます。

custom-agent.js

import SuperAgent from 'superagent';

const csrfToken = document.querySelector('meta[name=csrf-token]').content;

export default {
  fire(method, url) {
    return SuperAgent[method](url).set('X-CSRF-Token', csrfToken);
  }
};

このように使ってください。

import Agent from './custom-agent'

Agent.fire('get', '/endpoint')
// => SuperAgent.get('/endpoint').set('X-CSRF-Token', csrfToken)
4
Nikhil Fadnis