Binary JSON, comunemente indicato come BSON, è un formato di serializzazione simile al JSON, ma che effettua l'encoding in binario del contenuto. In alcuni casi è particolarmente efficiente, per esempio se abbiamo una grande quantità di valori numerici o dati binari come immagini, tant'è che è utilizzato come formato di serializzazione nativa da diversi prodotti, non ultimo MongoDB.

ASP.NET Web API possiede un supporto nativo a BSON, che però non è attivo di default: fortunatamente tutto ciò che dobbiamo fare per configurarlo è modificare la classe di startup aggiungendo la seguente riga di codice.

public static void Register(HttpConfiguration config)
{
  ...

  config.Formatters.Add(new BsonMediaTypeFormatter());
}

Una volta che abbiamo aggiunto BsonMediaTypeFormatter, grazie alla content negotiation di ASP.NET Web API, il runtime selezionerà automaticamente questo formato quando verrà richiesto dal client. Pertanto, non dobbiamo effettuare alcuna modifica al codice dei nostri controller, che continueranno ad avere la stessa forma del passato:

public class ProductsController : ApiController
{
  public IEnumerable<Product> Get()
  {
    return Product.GetSome();
  }
}

Se ProductsController viene invocato da un browser, quindi, restituirà tipicamente un contenuto di tipo JSON o XML. Nel caso di un client che specifichi BSON, invece, la serializzazione avverrà in quest'ultimo formato.

Creare un client che sfrutti BSON è altrettanto semplice, e il primo passo è quello di aggiungere il seguente package NuGet:

Install-Package Microsoft.AspNet.WebApi.Client

A questo punto, possiamo sfruttare HttpClient per inoltrare la richiesta, e BsonMediaTypeFormatter per decodificarla:

var client = new HttpClient();

// impostiamo il content type desiderato
client.DefaultRequestHeaders.Accept.Clear();
client.DefaultRequestHeaders.Accept.Add(
  new MediaTypeWithQualityHeaderValue("application/bson"));

var result = await client.GetAsync("http://localhost:37085/api/products");

// utilizziamo il formatter per la decodifica
var formatter = new BsonMediaTypeFormatter();
var products = await result
  .Content
  .ReadAsAsync<IEnumerable<Product>>(new[] { formatter });

foreach (var product in content)
{
    Console.WriteLine(product);
}