Node.js ExpressのHTTP GETリクエスト


191

Node.jsまたはExpress.js内からHTTPリクエストを行うにはどうすればよいですか?別のサービスに接続する必要があります。呼び出しが非同期で、コールバックにリモートサーバーの応答が含まれていることを願っています。

回答:


219

これは私のサンプルのコードの一部です。これは非同期であり、JSONオブジェクトを返します。任意の形式のGETリクエストを実行できます。

より最適な方法(サンプルのみ)があることに注意してください。たとえば、配列に入れたチャンクを連結して結合するなどの代わりに...うまくいけば、正しい方向から始めることができます。

const http = require('http');
const https = require('https');

/**
 * getJSON:  RESTful GET request returning JSON object(s)
 * @param options: http options object
 * @param callback: callback to pass the results JSON object(s) back
 */

module.exports.getJSON = (options, onResult) => {
  console.log('rest::getJSON');
  const port = options.port == 443 ? https : http;

  let output = '';

  const req = port.request(options, (res) => {
    console.log(`${options.host} : ${res.statusCode}`);
    res.setEncoding('utf8');

    res.on('data', (chunk) => {
      output += chunk;
    });

    res.on('end', () => {
      let obj = JSON.parse(output);

      onResult(res.statusCode, obj);
    });
  });

  req.on('error', (err) => {
    // res.send('error: ' + err.message);
  });

  req.end();
};

次のようなオプションオブジェクトを作成することによって呼び出されます。

const options = {
  host: 'somesite.com',
  port: 443,
  path: '/some/path',
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
};

そして、コールバック関数を提供します。

たとえば、サービスでは、上記のRESTモジュールが必要であり、次のようにします。

rest.getJSON(options, (statusCode, result) => {
  // I could work with the resulting HTML/JSON here. I could also just return it
  console.log(`onResult: (${statusCode})\n\n${JSON.stringify(result)}`);

  res.statusCode = statusCode;

  res.send(result);
});

更新

async/ await(線形、コールバックなし)、プロミス、コンパイル時のサポート、インテリセンスを探している場合は、その要求を満たす軽量のHTTPおよびRESTクライアントを作成しました。

Microsoft typed-rest-client


@bryanmac完全なサンプルを送信/追加していただけますか?
StErMi 2013年

@bryanmacあなたの許可を得て、私が現在構築しているこのコードのうなり声プラグインを使用したいと思います。いつかはわかりませんが、完了時にオープンソース化されます。
JeffH 2013

3
リクエストモジュールを試してください..それははるかに簡単ですsitepoint.com/making-http-requests-in-node-js
saurshaz

6
はい-要求モジュールは単純ですが、これは要求モジュールのようなライブラリが実行していることを示す下位レベルです。下位レベルの制御またはhttp要求(大規模なダウンロードなどの進行状況を表示)が必要な場合は、これがどのように行われるかを示します。
bryanmac 2013

1
@KrIsHnA-ノードにはクエリ文字列オブジェクトがあります:nodejs.org/api/querystring.htmlおよびurlオブジェクトnodejs.org/docs/latest/api/url.html
bryanmac

100

node.jsで単純なhttp.get(options, callback)関数を使用してみてください。

var http = require('http');
var options = {
  host: 'www.google.com',
  path: '/index.html'
};

var req = http.get(options, function(res) {
  console.log('STATUS: ' + res.statusCode);
  console.log('HEADERS: ' + JSON.stringify(res.headers));

  // Buffer the body entirely for processing as a whole.
  var bodyChunks = [];
  res.on('data', function(chunk) {
    // You can process streamed parts here...
    bodyChunks.push(chunk);
  }).on('end', function() {
    var body = Buffer.concat(bodyChunks);
    console.log('BODY: ' + body);
    // ...and/or process the entire body here.
  })
});

req.on('error', function(e) {
  console.log('ERROR: ' + e.message);
});

リクエストメソッドやその他のリクエストの詳細を指定できる一般的なhttp.request(options, callback)機能もあります。


OPが要求したサーバーの応答の内容はどこにありますか?
Dan Dascalescu 2013

更新していただきありがとうございます。その場合、チャンクを連結するための「終了」ハンドラが必要であるように見えます。基本的にどれが@bryanmacの答えに相当しますか?
Dan Dascalescu 2013

@DanDascalescu:ええ、本体全体を処理する場合(そうである可能性が高い)は、おそらくそれをバッファして「終了」時に処理する必要があります。完全を期すため、回答も更新します。
maerics 2013

申し訳ありませんが、コールバックがどのパラメーターで呼び出されているのかわかりません...どのようにしてボディを取得でき、パラメーターとパラメーターのプロパティの参照はどこにありますか。
ムハンマドウメール2015

@maerics GETこのURLがある場合、このリクエストをどのように使用できますか?graph.facebook.com/debug_token? input_token={token-to-inspect} &access_token={app-token-or-admin-token}
frank17

70

RequestSuperagentは、使用に適したライブラリです。

注:リクエストは非推奨です。リスクを伴います。

使用request

var request=require('request');

request.get('https://someplace',options,function(err,res,body){
  if(err) //TODO: handle err
  if(res.statusCode === 200 ) //etc
  //TODO Do something with response
});

7
それは秒でres.statusCode === 200でなければなりませんか?)
Gleb Dolzikov

1
オプション変数とは何ですか?未定義のものを渡すだけですか?疑わしい
lxknvlk

32

また、使用することができますRequestify、私はnodeJSために書いた本当にクールな、非常にシンプルなHTTPクライアントを+それがキャッシュをサポートしています。

GETメソッドのリクエストについては、次の手順を実行してください。

var requestify = require('requestify');

requestify.get('http://example.com/api/resource')
  .then(function(response) {
      // Get the response body (JSON parsed or jQuery object for XMLs)
      response.getBody();
  }
);

1
「他のツールを試す」は、既存のツールセットで十分な場合、許容できる応答ではありません。
Grunion Shaftoe

9

このバージョンは、promise、より優れたエラー処理を使用し、ES6で書き直されたbryanmac関数によって最初に提案されたものに基づいています。

let http = require("http"),
    https = require("https");

/**
 * getJSON:  REST get request returning JSON object(s)
 * @param options: http options object
 */
exports.getJSON = function(options)
{
    console.log('rest::getJSON');
    let reqHandler = +options.port === 443 ? https : http;

    return new Promise((resolve, reject) => {
        let req = reqHandler.request(options, (res) =>
        {
            let output = '';
            console.log('rest::', options.host + ':' + res.statusCode);
            res.setEncoding('utf8');

            res.on('data', function (chunk) {
                output += chunk;
            });

            res.on('end', () => {
                try {
                    let obj = JSON.parse(output);
                    // console.log('rest::', obj);
                    resolve({
                        statusCode: res.statusCode,
                        data: obj
                    });
                }
                catch(err) {
                    console.error('rest::end', err);
                    reject(err);
                }
            });
        });

        req.on('error', (err) => {
            console.error('rest::request', err);
            reject(err);
        });

        req.end();
    });
};

その結果、コールバック関数を渡す必要がなくなり、代わりにgetJSON()がpromiseを返します。次の例では、関数がExpressJSルートハンドラー内で使用されています。

router.get('/:id', (req, res, next) => {
    rest.getJSON({
        host: host,
        path: `/posts/${req.params.id}`,
        method: 'GET'
    }).then(({status, data}) => {
        res.json(data);
    }, (error) => {
        next(error);
    });
});

エラー時には、エラーをサーバーのエラー処理ミドルウェアに委任します。


1
はい、この例はExpress getルート定義内でそれを行う方法を示していますが、ここでは多くの投稿に欠けています。
Micros 2018

7

Unirestは、NodeからのHTTPリクエストを作成するために出会った中で最高のライブラリです。これはマルチプラットフォームフレームワークであることを目的としているため、Ruby、PHP、Java、Python、Objective C、.Net、またはWindows 8でHTTPクライアントを使用する必要がある場合にも、Nodeでどのように機能するかを学習すると役立ちます。私が知る限り、unirestライブラリは既存のHTTPクライアント(Java、Apache HTTPクライアント、Node、MikealのRequestライブラリなど)によってほとんど支えられています-Unirestはより優れたAPIを上に置いています。

Node.jsのコード例をいくつか示します。

var unirest = require('unirest')

// GET a resource
unirest.get('http://httpbin.org/get')
  .query({'foo': 'bar'})
  .query({'stack': 'overflow'})
  .end(function(res) {
    if (res.error) {
      console.log('GET error', res.error)
    } else {
      console.log('GET response', res.body)
    }
  })

// POST a form with an attached file
unirest.post('http://httpbin.org/post')
  .field('foo', 'bar')
  .field('stack', 'overflow')
  .attach('myfile', 'examples.js')
  .end(function(res) {
    if (res.error) {
      console.log('POST error', res.error)
    } else {
      console.log('POST response', res.body)
    }
  })

ここのノードのドキュメントに直接ジャンプできます



3

httpreqを確認してください。これは、単純なhttp GETモジュールやPOSTモジュールがそこにないことにイライラしたため、私が作成したノードライブラリです;-)


0

単純なgetリクエストを作成する必要があるだけで、他のHTTPメソッドのサポートは必要ない場合は、以下をご覧ください。simple-get

var get = require('simple-get');

get('http://example.com', function (err, res) {
  if (err) throw err;
  console.log(res.statusCode); // 200
  res.pipe(process.stdout); // `res` is a stream
});

0

reqclientを使用しrequestます。または他の多くのライブラリのようなスクリプト作成目的で設計されていません。Reqclientは、コンストラクターで同じ構成を何度も再利用する必要があるときに役立つ多くの構成を指定できるようにします。ベースURL、ヘッダー、認証オプション、ロギングオプション、キャッシングなどです。クエリとURLの解析、自動クエリエンコーディング、 JSON解析など

ライブラリを使用する最良の方法は、APIを指すオブジェクトと接続に必要な構成をエクスポートするモジュールを作成することです。

モジュールclient.js

let RequestClient = require("reqclient").RequestClient

let client = new RequestClient({
  baseUrl: "https://myapp.com/api/v1",
  cache: true,
  auth: {user: "admin", pass: "secret"}
})

module.exports = client

そして、APIを使用する必要があるコントローラーでは、次のように使用します。

let client = require('client')
//let router = ...

router.get('/dashboard', (req, res) => {
  // Simple GET with Promise handling to https://myapp.com/api/v1/reports/clients
  client.get("reports/clients")
    .then(response => {
       console.log("Report for client", response.userId)  // REST responses are parsed as JSON objects
       res.render('clients/dashboard', {title: 'Customer Report', report: response})
    })
    .catch(err => {
      console.error("Ups!", err)
      res.status(400).render('error', {error: err})
    })
})

router.get('/orders', (req, res, next) => {
  // GET with query (https://myapp.com/api/v1/orders?state=open&limit=10)
  client.get({"uri": "orders", "query": {"state": "open", "limit": 10}})
    .then(orders => {
      res.render('clients/orders', {title: 'Customer Orders', orders: orders})
    })
    .catch(err => someErrorHandler(req, res, next))
})

router.delete('/orders', (req, res, next) => {
  // DELETE with params (https://myapp.com/api/v1/orders/1234/A987)
  client.delete({
    "uri": "orders/{client}/{id}",
    "params": {"client": "A987", "id": 1234}
  })
  .then(resp => res.status(204))
  .catch(err => someErrorHandler(req, res, next))
})

reqclientは多くの機能をサポートしていますが、他のライブラリではサポートされていない機能がいくつかあります。OAuth2統合cURL構文とのロガー統合であり、常にネイティブのPromiseオブジェクトを返します。


0

と同様ににGETリクエストを送信する必要がある場合(他の回答では、変数を指定できることについて言及していません)、この関数を利用できます。IPDomainport

function getCode(host, port, path, queryString) {
    console.log("(" + host + ":" + port + path + ")" + "Running httpHelper.getCode()")

    // Construct url and query string
    const requestUrl = url.parse(url.format({
        protocol: 'http',
        hostname: host,
        pathname: path,
        port: port,
        query: queryString
    }));

    console.log("(" + host + path + ")" + "Sending GET request")
    // Send request
    console.log(url.format(requestUrl))
    http.get(url.format(requestUrl), (resp) => {
        let data = '';

        // A chunk of data has been received.
        resp.on('data', (chunk) => {
            console.log("GET chunk: " + chunk);
            data += chunk;
        });

        // The whole response has been received. Print out the result.
        resp.on('end', () => {
            console.log("GET end of response: " + data);
        });

    }).on("error", (err) => {
        console.log("GET Error: " + err);
    });
}

ファイルの先頭にある必須モジュールをお見逃しなく:

http = require("http");
url = require('url')

またhttps、セキュリティで保護されたネットワークを介して通信するためにモジュールを使用できることも覚えておいてください。したがって、次の2行が変更されます。

https = require("https");
...
https.get(url.format(requestUrl), (resp) => { ......

-1
## you can use request module and promise in express to make any request ##
const promise                       = require('promise');
const requestModule                 = require('request');

const curlRequest =(requestOption) =>{
    return new Promise((resolve, reject)=> {
        requestModule(requestOption, (error, response, body) => {
            try {
                if (error) {
                    throw error;
                }
                if (body) {

                    try {
                        body = (body) ? JSON.parse(body) : body;
                        resolve(body);
                    }catch(error){
                        resolve(body);
                    }

                } else {

                    throw new Error('something wrong');
                }
            } catch (error) {

                reject(error);
            }
        })
    })
};

const option = {
    url : uri,
    method : "GET",
    headers : {

    }
};


curlRequest(option).then((data)=>{
}).catch((err)=>{
})

(たまたま、問題​​は解決しません。このコードはリクエストリッスンしますが、質問はリクエストの送信方法を尋ねています
Quentin

1
修正されていますので、お試しください。@クエンティン
izhar ahmad
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.