Skip to main content

GET call of REST API that contains '/'-slash character in the value of a parameter

Let’s assume that we have the following scenario: I have a public HTTP endpoint and I need to post some content using GET command. One of the parameters contains special characters like “\” and “/”. If the endpoint is an ApiController than you may have problems if you encode the parameter using the http encoder.
using (var httpClient = new HttpClient())
            {
                httpClient.BaseAddress = baseUrl;
                Task<HttpResponseMessage> response = httpClient.GetAsync(string.Format("api/foo/{0}", "qwert/qwerqwer")));
                response.Wait();
                response.Result.EnsureSuccessStatusCode();
            }
One possible solution would be to encode the query parameter using UrlTokenEncode method of HttpServerUtility class and GetBytes method ofUTF8. In this way you would get the array of bytes of the parameter and encode them as a url token.
The following code show to you how you could write the encode and decode methods.
public class EncoderHelper
{
    public static string Encode(string content)
    {
        byte[] encodedBytes = UTF8Encoding.UTF8.GetBytes(content);
        string externalIdEncoded = HttpServerUtility.UrlTokenEncode(encodedBytes);

        return externalIdEncoded;
    }

    public static string Decode(string content)
    {
            var decodedBytes = HttpServerUtility.UrlTokenDecode(content);
        string externalId = UTF8Encoding.UTF8.GetString(decodedBytes);

        return externalId;
    }
}
There are also other ways to resolve this problem. This is just one of the possible solution to resolve this problem.
The call of the GET endpoint should look like something like this.
using (var httpClient = new HttpClient())
            {
                httpClient.BaseAddress = baseUrl;
                Task<HttpResponseMessage> response = httpClient.GetAsync(string.Format("api/foo/{0}", EncoderHelper.Encode("qwert/qwerqwer"))));
                response.Wait();
                response.Result.EnsureSuccessStatusCode();
            } 
Also, don't forget that you would need to use the Decode method on the other end.

Comments

  1. Why not WebUtility.UrlEncode ?
    (or HttpUtility.UrlEncode if a dependency to System.Web it's ok)

    ReplyDelete
    Replies
    1. Give it a try and see what is happening when you have "\" and "/" on the server side (in the APIController).

      Delete
    2. Strange - when the server receives a percent-encoded / (%2F) in the URI, it should not interpret it as a path separator and use it for routing..

      Delete
    3. You are right, and there seems to be a setting for that in .NET: http://msdn.microsoft.com/en-us/library/ee656542(v=vs.110).aspx : genericUriParserOptions="DontUnescapePathDotsAndSlashes"

      Delete

Post a Comment

Popular posts from this blog

ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded

Today blog post will be started with the following error when running DB tests on the CI machine:
threw exception: System.InvalidOperationException: The Entity Framework provider type 'System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer' registered in the application config file for the ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded. Make sure that the assembly-qualified name is used and that the assembly is available to the running application. See http://go.microsoft.com/fwlink/?LinkId=260882 for more information. at System.Data.Entity.Infrastructure.DependencyResolution.ProviderServicesFactory.GetInstance(String providerTypeName, String providerInvariantName) This error happened only on the Continuous Integration machine. On the devs machines, everything has fine. The classic problem – on my machine it’s working. The CI has the following configuration:

TeamCity.NET 4.51EF 6.0.2VS2013
It seems that there …

How to check in AngularJS if a service was register or not

There are cases when you need to check in a service or a controller was register in AngularJS.
For example a valid use case is when you have the same implementation running on multiple application. In this case, you may want to intercept the HTTP provider and add a custom step there. This step don’t needs to run on all the application, only in the one where the service exist and register.
A solution for this case would be to have a flag in the configuration that specify this. In the core you would have an IF that would check the value of this flag.
Another solution is to check if a specific service was register in AngularJS or not. If the service was register that you would execute your own logic.
To check if a service was register or not in AngularJS container you need to call the ‘has’ method of ‘inhector’. It will return TRUE if the service was register.
if ($injector.has('httpInterceptorService')) { $httpProvider.interceptors.push('httpInterceptorService&#…

Fundamental Books of a Software Engineer (version 2018)

More then six years ago I wrote a blog post about fundamental books that any software engineer (developer) should read. Now it is an excellent time to update this list with new entries.

There are 5 different categories of books, that represent the recommended path. For example, you start with Coding books, after that, you read books about Programming, Design and so on.
There are some books about C++ that I recommend not because you shall know C++, only because the concepts that you can learn from it.

Coding

Writing solid codeCode completeProgramming Pearls, more programming pearls(recommended)[NEW] Introduction to Algorithms

Programming

Refactoring (M. Fowler)Pragmatic ProgrammerClean code[NEW] Software Engineering: A Practitioner's Approach[NEW] The Mythical Man-Month[NEW] The Art of Computer Programming

Design

Applying UML and Patterns (GRASP patterns)C++ coding standards (Sutter, Alexandrescu)The C++ programming language (Stroustrup, Part IV)Object-oriented programming (Peter Coad)P…