AngularでHTTPリクエストにURL引数(クエリ文字列)を渡す方法は?


266

AngularでHTTPリクエストを作成していますが、URL引数(クエリ文字列)を追加する方法がわかりません。

this.http.get(StaticSettings.BASE_URL).subscribe(
  (response) => this.onGetForecastResult(response.json()),
  (error) => this.onGetForecastError(error.json()),
  () => this.onGetForecastComplete()
);

今、私のStaticSettings.BASE_URLのような無クエリ文字列を含むURLのようなものです:http://atsomeplace.com/が、私はそれになりたいhttp://atsomeplace.com/?var1=val1&var2=val2

var1とvar2は、私のHttpリクエストオブジェクトのどこに収まりますか?オブジェクトのように追加したい。

{
  query: {
    var1: val1,
    var2: val2
  }
}

次に、Httpモジュールだけがそれを解析してURLクエリ文字列に変換します。


stackoverflow.com/questions/26541801/…これを参照してください。呼び出す前にURLを作成し、BASE_URLの代わりにサブスクライブ関数に渡します。2cents
プラティクパワ

回答:


330

HttpClientをする方法は、あなたが設定できるようにするのparamsをそれのオプションで。

@ angular / common / httpパッケージからHttpClientModuleをインポートして構成できます。

import {HttpClientModule} from '@angular/common/http';

@NgModule({
  imports: [ BrowserModule, HttpClientModule ],
  declarations: [ App ],
  bootstrap: [ App ]
})
export class AppModule {}

その後、HttpClientを注入し、それを使用してリクエストを実行できます。

import {HttpClient} from '@angular/common/http'

@Component({
  selector: 'my-app',
  template: `
    <div>
      <h2>Hello {{name}}</h2>
    </div>
  `,
})
export class App {
  name:string;
  constructor(private httpClient: HttpClient) {
    this.httpClient.get('/url', {
      params: {
        appid: 'id1234',
        cnt: '5'
      },
      observe: 'response'
    })
    .toPromise()
    .then(response => {
      console.log(response);
    })
    .catch(console.log);
  }
}

バージョン4より前の角度バージョンの場合は、Httpサービスを使用して同じことができます。

Http.getの方法は、その実装オブジェクトを受け取りRequestOptionsArgs 2番目のパラメータとして。

そのオブジェクトの検索フィールドを使用して、文字列またはURLSearchParamsオブジェクトを設定できます。

例:

 // Parameters obj-
 let params: URLSearchParams = new URLSearchParams();
 params.set('appid', StaticSettings.API_KEY);
 params.set('cnt', days.toString());

 //Http request-
 return this.http.get(StaticSettings.BASE_URL, {
   search: params
 }).subscribe(
   (response) => this.onGetForecastResult(response.json()), 
   (error) => this.onGetForecastError(error.json()), 
   () => this.onGetForecastComplete()
 );

Httpクラスのドキュメントに詳細があります。これはここにあり、実際の例はここにあります


2
要点:gist.github.com/MiguelLattuada/bb502d84854ad9fc26e0 URLSearchParamsオブジェクトの使用方法、ありがとう@toskv
Miguel Lattuada

1
URLSearchParamsで超スリック!JSONオブジェクトのシリアル化に関する私の問題を解決しました。
ローガンH

2
@SukumarMSはパスの一部であるため、特別なことは必要ありません。文字列 'blabla.com/page/' + page + '/ activeFilter' + activeFilterを連結するだけです。または、テンプレートリテラル `blabla.com/page / $ {page} / $ {activeFilter}`を使用する場合。
-toskv

10
これは私にとってはうまくhttp.get(url, {params: {var1: val1, var2: val2}})
いき

8
searchプロパティは4.0.0から廃止されました-> params代わりに使用してください
BotanMan

180

角度を編集> = 4.3.x

HttpClientHttpParamsとともに導入されました。以下の使用例:

import { HttpParams, HttpClient } from '@angular/common/http';

constructor(private http: HttpClient) { }

let params = new HttpParams();
params = params.append('var1', val1);
params = params.append('var2', val2);

this.http.get(StaticSettings.BASE_URL, {params: params}).subscribe(...);

(古い答え)

角度を編集> = 4.x

requestOptions.search廃止されました。requestOptions.params代わりに使用:

let requestOptions = new RequestOptions();
requestOptions.params = params;

元の回答(Angular 2)

URLSearchParams以下のようにインポートする必要があります

import { Http, RequestOptions, URLSearchParams } from '@angular/http';

次に、パラメーターを作成し、httpリクエストを次のように実行します。

let params: URLSearchParams = new URLSearchParams();
params.set('var1', val1);
params.set('var2', val2);

let requestOptions = new RequestOptions();
requestOptions.search = params;

this.http.get(StaticSettings.BASE_URL, requestOptions)
    .toPromise()
    .then(response => response.json())
...

3
私のために働いていません。ソースコードを詳しく調べたところ、http.getの2番目のパラメーターは、URLSearchParamsが実装していないRequestOptionsArgsインターフェイスを想定していることがわかりました。RequestOptionsオブジェクト内でsearchParamsをラップすると機能します。でもショートカットがあるといいですね。
hardsetting

3
あなたは完全に正しいです、私は忘れましたRequestOptions。回答を更新しました。
Radouane ROUFID 2017

1
の廃止を指摘していただきありがとうございsearchます。問題を修正しました
Hayden Braxton

この変更を指摘していただきありがとうございます。私が何時間も見つけたすべてのドキュメントと問題は、searchプロパティにparamsをアタッチするように言っています。
rayepps 2017

63

バージョン5+

Angular 5以降では、HttpParamsを使用する必要はありません。以下に示すように、jsonオブジェクトを直接送信できます。

let data = {limit: "2"};
this.httpClient.get<any>(apiUrl, {params: data});

データ値は文字列でなければならないことに注意してください。 { params: {limit: "2"}}

バージョン4.3.x +

@ angular / common / httpのHttpParams、HttpClientを使用します

import { HttpParams, HttpClient } from '@angular/common/http';
...
constructor(private httpClient: HttpClient) { ... }
...
let params = new HttpParams();
params = params.append("page", 1);
....
this.httpClient.get<any>(apiUrl, {params: params});

一部を助けるかもしれない!


@BrunoPeresは、ネストされたオブジェクトを文字列化してみますJSON.stringify()
Rahmathullah M

1
@RahmathullahM-ビチュ、THX :)
Jamsheer

12

角度6

paramsを使用して、get呼び出しに必要なパラメーターを渡すことができます。

this.httpClient.get<any>(url, { params: x });

ここで、x = {property: "123"}です。

「123」をログに記録するAPI関数について:

router.get('/example', (req, res) => {
    console.log(req.query.property);
})

2
のは、バージョン5で追加変更は、すでにここに追加されたことをstackoverflow.com/a/45455904/3276721
ミゲルLattuada

9

私の例

private options = new RequestOptions({headers: new Headers({'Content-Type': 'application/json'})});

私の方法

  getUserByName(name: string): Observable<MyObject[]> {
    //set request params
    let params: URLSearchParams = new URLSearchParams();
    params.set("name", name);
    //params.set("surname", surname); for more params
    this.options.search = params;

    let url = "http://localhost:8080/test/user/";
    console.log("url: ", url);

    return this.http.get(url, this.options)
      .map((resp: Response) => resp.json() as MyObject[])
      .catch(this.handleError);
  }

  private handleError(err) {
    console.log(err);
    return Observable.throw(err || 'Server error');
  }

私のコンポーネントで

  userList: User[] = [];
  this.userService.getUserByName(this.userName).subscribe(users => {
      this.userList = users;
    });

郵便配達

http://localhost:8080/test/user/?name=Ethem

6

最新のAngular 7/8では、最も簡単な方法を使用できます:-

import { HttpClient, HttpHeaders, HttpParams } from '@angular/common/http';

getDetails(searchParams) {
    const httpOptions = {
        headers: { 'Content-Type': 'application/json' },
        params: { ...searchParams}
    };
    return this.http.get(this.Url, httpOptions);
}

searchParams' いずれかのプロパティがstring値でない場合、これは機能しません。
ユリアン

5

複数のパラメータを送信する予定の場合。

成分

private options = {
  sort:   '-id',
  select: null,
  limit:  1000,
  skip:   0,
  from:   null,
  to:     null
};

constructor(private service: Service) { }

ngOnInit() {
  this.service.getAllItems(this.options)
    .subscribe((item: Item[]) => {
      this.item = item;
    });
}

サービス

private options = new RequestOptions({headers: new Headers({'Content-Type': 'application/json'})});
constructor(private http: Http) { }

getAllItems(query: any) {
  let params: URLSearchParams = new URLSearchParams();
  for(let key in query){
    params.set(key.toString(), query[key]);
  }
  this.options.search = params;
  this.header = this.headers();

そして、@ ethemsulanが行った方法と同じようにhttpリクエストを続行します。

サーバー側ルート

router.get('/api/items', (req, res) => {
  let q = {};
  let skip = req.query.skip;
  let limit = req.query.limit;
  let sort  = req.query.sort;
  q.from = req.query.from;
  q.to = req.query.to;

  Items.find(q)
    .skip(skip)
    .limit(limit)
    .sort(sort)
    .exec((err, items) => {
      if(err) {
        return res.status(500).json({
          title: "An error occurred",
          error: err
        });
      }
      res.status(200).json({
        message: "Success",
        obj:  items
      });
    });
});

サービスのgetリクエストで、getリクエストの処理方法がわかりません。
Winnemucca 2017年

ああ、私はあなたがそのメソッドにエトムスランの答えのようなリターンとしてhttp getリクエストを入れると思います
mjwrazor

2

@ angular / common / httpからHttpParamsを使用して、クエリで文字列を渡すことができます。例えば:

import { HttpClient, HttpParams } from '@angular/common/http';
const query = 'key=value' // date=2020-03-06

const options = {
  params: new HttpParams({
    fromString: query
  })
}

今あなたのコードで

this.http.get(urlFull, options);

そしてこれはあなたのために働く:)

私はあなたを助けたいと思います


0
import ...
declare var $:any;
...
getSomeEndPoint(params:any): Observable<any[]> {
    var qStr = $.param(params); //<---YOUR GUY
    return this._http.get(this._adUrl+"?"+qStr)
      .map((response: Response) => <any[]> response.json())
      .catch(this.handleError);
}

あなたがしたことを提供するのjQueryをインストールし、私がやるnpm i jquery --saveとに含めるapps.scriptsangular-cli.json


0
import { Http, Response } from '@angular/http';
constructor(private _http: Http, private router: Router) {
}

return this._http.get('http://url/login/' + email + '/' + password)
       .map((res: Response) => {
           return res.json();
        }).catch(this._handleError);

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.