Devolver un JSON en Azure Functions

En esta entrada voy a tratar de, a partir de una Azure Function tipo «Hello World«, devolver un JSON en lugar de un XML que es lo que Azure Function devuelve por defecto.

Partiendo por lo tanto de un ejemplo tipo «Hello World«, vamos a modificar el código para lograr nuestro propósito.

Lo primero de todo es situarnos en el código de nuestra Azure Function, o lo que es lo mismo, en run.csx.

Dentro del código, agregaremos al principio la siguiente instrucción:

#r «Newtonsoft.Json»

Con esta instrucción, estaremos indicando a Azure Function que queremos incluir en nuestro proyecto el paquete Newtonsoft.Json.
Al ser un paquete muy utilizado y globalmente estandarizado, podemos indicar su referencia con #r para que sea utilizado.

No obstante, con referenciar el paquete, no estaremos indicando o posibilitando a nuestra Azure Function a usarlo, por lo que no deberemos olvidar el using en C#:

using Newtonsoft.Json;

También agregaremos otro using a nuestro código:

using System.Text;

Antes de seguir, me gustaría hacer un pequeño alto en el camino respecto a las referencias que podemos utilizar en nuestras Azure Functions, ya que no podemos utilizar todas las que queramos, sino sólo algunas de ellas.
En el siguiente enlace, se indica información respecto al uso de referencias en Azure Functions (mirar especialmente la sección Referencing external assemblies).

¿Y qué ocurre si queremos utilizar otras referencias a paquetes externos que no estén habilitadas mediante r#?. ¿Es posible añadirlas?.
Sí, pero eso lo veremos en otras entradas futuras.

Bien… sigamos entonces en donde lo habíamos dejado.

Hemos agregado una referencia al paquete Newtonsoft.Json y hemos agregado un using para poder utilizar las clases de ese paquete dentro de nuestra Azure Function.

Ahora sólo nos queda agregar el código que haga posible devolver un JSON en lugar de un XML.

Para preparar el JSON que voy a devolver, voy a montarme un objeto con el valor del nombre que habrá recibido la Azure Function, y serializaré esa información con JsonConvert de Newtonsoft.

var myObject = new {greeting = «Hello » + name};
var jsonToReturn = JsonConvert.SerializeObject(myObject);

Y finalmente devolveré la información a la petición.

En definitiva, nuestro código completo quedará de esta forma:

#r "Newtonsoft.Json"
using Newtonsoft.Json;
using System.Net;
using System.Text;

public static async Task<HttpResponseMessage> Run(HttpRequestMessage req, TraceWriter log)
{
    log.Info("C# HTTP trigger function processed a request.");

    // parse query parameter
    string name = req.GetQueryNameValuePairs()
        .FirstOrDefault(q => string.Compare(q.Key, "name", true) == 0)
        .Value;

    // Get request body
    dynamic data = await req.Content.ReadAsAsync<object>();

    // Set name to query string or body data
    name = name ?? data?.name;

    var myObject = new {greeting = "Hello " + name};
    var jsonToReturn = JsonConvert.SerializeObject(myObject);

    return name == null
        ? req.CreateResponse(HttpStatusCode.BadRequest, "Please pass a name on the query string or in the request body")
        : new HttpResponseMessage(HttpStatusCode.OK) 
        {
            Content = new StringContent(jsonToReturn, Encoding.UTF8, "application/json")
        };

}

Y nuestra Azure Function en ejecución quedará tal y como se muestra en la siguiente imagen:

Como puedes ver, devolver un JSON en una Azure Function es realmente sencillo.

¡Happy Coding!