jrapose
jrapose

Reputation: 121

How to encode query params containing special characters in Angular 7?

I am trying to encode query parameter values in Angular 7. But I get 400 Bad Request status code, when my query parameter values contain any special character

Failed Request URL: http://localhost/api/67/cardvalues?parentcardvalues=STONE&parentcardvalues=STONE%20AGE

However, I get 200 OK status code , when my query parameter values do not contain any special characters.

Successful Request URL: http://localhost/api/67/cardvalues?parentcardvalues=STONE&parentcardvalues=STONE

The expected request url has to be like http://localhost/cardvalues?parentcardvalues=VALUE1&parentcardvalues=VALUE2

Below is my code,

parentcardvalues=["STONE","STONE AGE"]

let myparams = new HttpParams();

    if(parentcardvalues.length != 0)
       parentcardvalues.forEach((value) => { 

myparams = myparams.append( 'parentcardvalues',   encodeURIComponent(value) );

});

 this.http.get(this.baseUrl + 'api/67/cardvalues', {params: myparams});

The Swagger specification is,

Curl

curl -X GET "http://localhost/api/cardvalues?parentcardvalues=STONE&parentcardvalues=STONE%20AGE" -H  "accept: application/json"

Request URL

http://localhost/api/cardvalues?parentcardvalues=STONE&parentcardvalues=STONE%20AGE

Upvotes: 9

Views: 27312

Answers (3)

marcel
marcel

Reputation: 3149

I created a new Encoder class:

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

export class CustomHttpParamEncoder implements HttpParameterCodec {
  encodeKey(key: string): string {
    return encodeURIComponent(key);
  }

  encodeValue(value: string): string {
    return encodeURIComponent(value);
  }

  decodeKey(key: string): string {
    return decodeURIComponent(key);
  }

  decodeValue(value: string): string {
    return decodeURIComponent(value);
  }
}

and then use it in the requests where I need it.

const params = new HttpParams({ encoder: new CustomHttpParamEncoder() })
  .set('parentcardvalues', value);
return this.httpClient.get(url, { params });

Upvotes: 2

tavOu
tavOu

Reputation: 7

Agree, and you can do a general change with urls problems with chars in urlserializer: https://angular.io/api/router/DefaultUrlSerializer https://angular.io/api/router/UrlSerializer

You can overwrite this in app.module.ts (provide:{..,..}) You can see this: Angular 2 - Implement UrlSerializer

regards

Upvotes: 0

you can decode your params using:

decodeURIComponent(encodedURI_string)

more information here

Upvotes: 5

Related Questions