如何在SuperAgent的每个请求中注入自定义HTTP标头?

时间:2015-06-25 19:46:27

标签: http-headers npm superagent

显然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);
     }
   });

我的问题:

  • 如果我通过npm下拉SuperAgent,我怎样才能在SuperAgent的所有请求中注入我自己的HTTP头?
  • 注意:我完全愿意创建一个新的npm包,如果有必要,可以扩展SuperAgent。

3 个答案:

答案 0 :(得分:23)

我只是制作一个单独的模块:

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

模块的行为与superagent相同,但在返回Request对象之前设置默认标头。见here

答案 1 :(得分:5)

这可能是迟到的答案,但我使用superagent-use插件在所有请求中注入自定义HTTP标头。首先,您需要安装superagent-use

npm install superagent-use --save

然后要求这样

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

然后将该函数添加为middlerware / interceptor

// 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

答案 2 :(得分:4)

所以在我的情况下,我需要在所有请求中将csrf标记设置为默认标头。您可以编写一个这样的简单包装函数。

定制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)