如何從Azure功能返回JSON

Question

我在使用Azure Functions。但是，我覺得我很難找到一些非常簡單的東西。我試圖找出如何返回一些基本的JSON。我不確定如何創建一些JSON並將其恢復到我的請求。

曾幾何時，我會創建一個對象，填充它的屬性並序列化它。於是，我開始了這條路：

#r "Newtonsoft.Json" 

using System.Net; 

public static async Task<HttpResponseMessage> Run(HttpRequestMessage req, TraceWriter log) 
{ 
    log.Info($"Running Function");  
    try {  
     log.Info($"Function ran"); 

     var myJSON = GetJson(); 

     // I want myJSON to look like: 
     // { 
     // firstName:'John', 
     // lastName: 'Doe', 
     // orders: [ 
     //  { id:1, description:'...' }, 
     //  ... 
     // ] 
     // } 
     return ?; 
    } catch (Exception ex) { 
     // TODO: Return/log exception 
     return null; 
    } 
} 

public static ? GetJson() 
{ 
    var person = new Person(); 
    person.FirstName = "John"; 
    person.LastName = "Doe"; 

    person.Orders = new List<Order>(); 
    person.Orders.Add(new Order() { Id=1, Description="..." }); 

    ? 
} 

public class Person 
{ 
    public string FirstName { get; set; } 
    public string LastName { get; set; } 
    public List<Order> Orders { get; set; } 
} 

public class Order 
{ 
    public int Id { get; set; } 
    public string Description { get; set; } 
} 

不過，我完全被困在序列化和返回過程now.I猜我已經習慣了在ASP.NET MVC返回JSON這裏的一切是動作

Answer 1

JSON很簡單，Newtonsoft.Json庫是一個special case。您可以通過在腳本文件的頂部添加此包括它：

#r "Newtonsoft.Json" 

using Newtonsoft.Json; 

那麼你的函數變爲：

public static string GetJson() 
{ 
    var person = new Person(); 
    person.FirstName = "John"; 
    person.LastName = "Doe"; 

    person.Orders = new List<Order>(); 
    person.Orders.Add(new Order() { Id=1, Description="..." }); 

    return JsonConvert.SerializeObject(person); 
} 

Answer 2

您可以更改方法簽名爲：

public static async Task<object> Run(HttpRequestMessage req, TraceWriter log) 

和它將允許返回JSON數據。

Answer 3

我有一個類似的問題，這似乎是最流行的職位，沒有答案。在弄清楚下面哪個節點應該工作後，給出你到底是什麼。其他示例仍會返回一個字符串表示形式，它將返回JSON。

記得使用System.Text聲明;並且還根據Juunas響應向GetJson函數添加：

return JsonConvert.SerializeObject(person); 

。

return new HttpResponseMessage(HttpStatusCode.OK) 
 
     { 
 
      Content = new StringContent(GetJson(), Encoding.UTF8, "application/json") 
 
     };

Answer 4

這裏有蔚藍的函數返回一個格式正確的JSON對象而不是XML的一個完整的例子：在瀏覽器中

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

public static async Task<HttpResponseMessage> Run(HttpRequestMessage req, TraceWriter log) 
{ 
    var myObj = new {name = "thomas", location = "Denver"}; 
    var jsonToReturn = JsonConvert.SerializeObject(myObj); 

    return new HttpResponseMessage(HttpStatusCode.OK) { 
     Content = new StringContent(jsonToReturn, Encoding.UTF8, "application/json") 
    }; 
} 

導航到終點，你會看到：

{ 
    "name": "thomas", 
    "location": "Denver" 
} 

Answer 5

您可以拿req從

public static async Task<HttpResponseMessage> Run(HttpRequestMessage req, TraceWriter log) 

，並創建在裝配System.Web.Http使用

return req.CreateResponse(HttpStatusCode.OK, json, "application/json"); 

或任何其他重載的響應。

更多信息上docs.microsoft.com

Answer 6

看起來這可以通過使用「應用/ JSON的」媒體類型剛剛實現，而無需顯式序列化Person與Newtonsoft.Json。

下面是在Chrome結果作爲完整的工作示例：

{"FirstName":"John","LastName":"Doe","Orders":[{"Id":1,"Description":"..."}]} 

的代碼給出如下：

[FunctionName("StackOverflowReturnJson")] 
    public static HttpResponseMessage Run([HttpTrigger("get", "post", Route = "StackOverflowReturnJson")]HttpRequestMessage req, TraceWriter log) 
    { 
     log.Info($"Running Function"); 
     try 
     { 
      log.Info($"Function ran"); 

      var myJSON = GetJson(); // Note: this actually returns an instance of 'Person' 

      // I want myJSON to look like: 
      // { 
      // firstName:'John', 
      // lastName: 'Doe', 
      // orders: [ 
      //  { id:1, description:'...' }, 
      //  ... 
      // ] 
      // } 
      var response = req.CreateResponse(HttpStatusCode.OK, myJSON, JsonMediaTypeFormatter.DefaultMediaType); // DefaultMediaType = "application/json" does the 'trick' 
      return response; 
     } 
     catch (Exception ex) 
     { 
      // TODO: Return/log exception 
      return null; 
     } 
    } 

    public static Person GetJson() 
    { 
     var person = new Person(); 
     person.FirstName = "John"; 
     person.LastName = "Doe"; 

     person.Orders = new List<Order>(); 
     person.Orders.Add(new Order() { Id = 1, Description = "..." }); 

     return person; 
    } 

    public class Person 
    { 
     public string FirstName { get; set; } 
     public string LastName { get; set; } 
     public List<Order> Orders { get; set; } 
    } 

    public class Order 
    { 
     public int Id { get; set; } 
     public string Description { get; set; } 
    }