Retourner des données JSON avec une API .NET Core 6
Introduction
.NET Core 6 est un framework puissant et flexible pour construire des API web. L'une des tâches les plus courantes lors de la création d'une API est de retourner des données au client sous forme de JSON. Ce format est léger et facilement parsable par diverses applications, ce qui le rend idéal pour la communication entre API et clients.
Dans cet article, nous allons explorer les différentes manières de retourner des données JSON à partir d'une API .NET Core 6.
Configuration de l'environnement
Avant de commencer à coder, assurez-vous que vous avez .NET Core 6 installé sur votre machine. Vous pouvez télécharger et installer le SDK .NET Core depuis le site officiel de Microsoft.
Créer un projet d'API
Pour démarrer, créez un nouveau projet d'API .NET Core 6 en utilisant la commande suivante dans votre console :
dotnet new webapi -o MyApi
Ceci créera un nouveau projet nommé MyApi dans le répertoire actuel.
Retourner des données JSON simples
Voici un exemple simple d'une API .NET Core 6 qui retourne une liste de produits sous forme de JSON :
using Microsoft.AspNetCore.Mvc;
namespace MyApi.Controllers
{
[ApiController]
[Route("[controller]")]
public class ProductsController : ControllerBase
{
[HttpGet]
public IActionResult GetProducts()
{
var products = new List
{
new Product { Id = 1, Name = "Produit 1", Price = 10.99 },
new Product { Id = 2, Name = "Produit 2", Price = 25.50 },
new Product { Id = 3, Name = "Produit 3", Price = 7.99 }
};
return Ok(products);
}
}
public class Product
{
public int Id { get; set; }
public string Name { get; set; }
public double Price { get; set; }
}
}
Dans cet exemple, la méthode GetProducts() retourne une liste de Product sous forme de JSON. La méthode Ok() de l'objet ControllerBase est utilisée pour retourner une réponse HTTP 200 avec les données JSON.
Utiliser la sérialisation JSON
.NET Core 6 utilise Newtonsoft.Json par défaut pour la sérialisation JSON. Vous pouvez également utiliser System.Text.Json, une bibliothèque native de .NET Core, pour la sérialisation JSON.
Voici un exemple de sérialisation JSON avec System.Text.Json :
using System.Text.Json;
namespace MyApi.Controllers
{
[ApiController]
[Route("[controller]")]
public class ProductsController : ControllerBase
{
[HttpGet]
public IActionResult GetProducts()
{
var products = new List
{
new Product { Id = 1, Name = "Produit 1", Price = 10.99 },
new Product { Id = 2, Name = "Produit 2", Price = 25.50 },
new Product { Id = 3, Name = "Produit 3", Price = 7.99 }
};
// Sérialiser les données en JSON
var json = JsonSerializer.Serialize(products);
// Retourner les données JSON
return Content(json, "application/json");
}
}
public class Product
{
public int Id { get; set; }
public string Name { get; set; }
public double Price { get; set; }
}
}
Dans cet exemple, la méthode Serialize() de JsonSerializer est utilisée pour convertir la liste de Product en JSON. La méthode Content() de l'objet ControllerBase est utilisée pour retourner une réponse HTTP avec les données JSON.
Conclusion
Retourner des données JSON à partir d'une API .NET Core 6 est une tâche simple. En utilisant les outils intégrés de .NET Core et en comprenant les bases de la sérialisation JSON, vous pouvez facilement construire des API qui communiquent efficacement avec les clients.