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

Why Database Modernization Matters for AI

  When companies transition to the cloud, they typically begin with applications and virtual machines, which is often the easier part of the process. The actual complexity arises later when databases are moved. To save time and effort, cloud adoption is more of a cloud migration in an IaaS manner, fulfilling current, but not future needs. Even organisations that are already in the cloud find that their databases, although “migrated,” are not genuinely modernised. This disparity becomes particularly evident when they begin to explore AI technologies. Understanding Modernisation Beyond Migration Database modernisation is distinct from merely relocating an outdated database to Azure. It's about making your data layer ready for future needs, like automation, real-time analytics, and AI capabilities. AI needs high throughput, which can be achieved using native DB cloud capabilities. When your database runs in a traditional setup (even hosted in the cloud), in that case, you will enc...

Cloud Myths: Migrating to the cloud is quick and easy (Pill 2 of 5 / Cloud Pills)

The idea that migration to the cloud is simple, straightforward and rapid is a wrong assumption. It’s a common misconception of business stakeholders that generates delays, budget overruns and technical dept. A migration requires laborious planning, technical expertise and a rigorous process.  Migrations, especially cloud migrations, are not one-size-fits-all journeys. One of the most critical steps is under evaluation, under budget and under consideration. The evaluation phase, where existing infrastructure, applications, database, network and the end-to-end estate are evaluated and mapped to a cloud strategy, is crucial to ensure the success of cloud migration. Additional factors such as security, compliance, and system dependencies increase the complexity of cloud migration.  A misconception regarding lift-and-shits is that they are fast and cheap. Moving applications to the cloud without changes does not provide the capability to optimise costs and performance, leading to ...

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills)

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills) The idea that moving to the cloud reduces the costs is a common misconception. The cloud infrastructure provides flexibility, scalability, and better CAPEX, but it does not guarantee lower costs without proper optimisation and management of the cloud services and infrastructure. Idle and unused resources, overprovisioning, oversize databases, and unnecessary data transfer can increase running costs. The regional pricing mode, multi-cloud complexity, and cost variety add extra complexity to the cost function. Cloud adoption without a cost governance strategy can result in unexpected expenses. Improper usage, combined with a pay-as-you-go model, can result in a nightmare for business stakeholders who cannot track and manage the monthly costs. Cloud-native services such as AI services, managed databases, and analytics platforms are powerful, provide out-of-the-shelve capabilities, and increase business agility and innovation. H...