Skip to content
A safer and more readable way to build URI's in .NET
C# Batchfile
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.


Type Name Latest commit message Commit time
Failed to load latest commit information.


A safer and more readable way to build URI's in .NET

Build status NuGet package

Quick example

To build this new URI:


var uri = FluentUriBuilder.Create()
    .Credentials("user", "password")
    .QueryParams(new {
        param1 = "val1",
        param2 = "a#value&with@weird?characters"


You often see code that creates URI's using simple string concatenation or format strings:

var valueWithWeirdCharacters = "a#value&with@weird?characters";
var badUri1 = "" + valueWithWeirdCharacters + "&param2=asdf";
var badUri2 = string.Format("{0}&param2=asdf", valueWithWeirdCharacters);

The result is an invalid URI because the value of param1 is not escaped:


One alternative is to escape each value using Uri.EscapeDataString:

var correctUri = "" +
    Uri.EscapeDataString(valueWithWeirdCharacters) +

But this quickly gets ugly when you have a lot of arguments, and it is easy to forget.

Enter System.UriBuilder:

var valueWithWeirdCharacters = "a#value&with@weird?characters";
var uriBuilder = new UriBuilder("");
var parameters = HttpUtility.ParseQueryString(string.Empty);

parameters["param1"] = valueWithWeirdCharacters;
parameters["param2"] = "asdf";

uriBuilder.Query = parameters.ToString();

var correctUri = uriBuilder.AbsoluteUri;

This is correct, but also the most complicated and unreadable of all of the above examples. This is why I created FluentUriBuilder: to allow creating URI's in a safe and readable way:

var valueWithWeirdCharacters = "a#value&with@weird?characters";
var uri = FluentUriBuilder
	.QueryParam("param1", valueWithWeirdCharacters)
	.QueryParam("param2", "asdf")

More Examples

Query parameters can also be specified using an IDictionary<TKey, TValue>:

var params = new Dictionary<string, string> {
	{ "user", "averagejoe236" },
	{ "apiKey", "af43af43rcfaf34xqf" }

var uri = FluentUriBuilder.Create()

Or one by one, by calling .QueryParam("key", "value") repeatedly:

var uri = FluentUriBuilder.Create()
	.QueryParam("q", "FluentUriBuilder")
	.QueryParam("source", "hp")

The latter can be used to specify more query parameters with the same name.

To modify an existing URI:

var uri = FluentUriBuilder.From("")

This example returns a System.Uri instance instead of a string because of the .ToUri() call at the end.

Framework Support

The project currently supports .NET 2.0+. .NET Core support is planned.

You can’t perform that action at this time.