.net 6 Return Json From Controller

4 min read Jun 03, 2024

Retourner des données JSON depuis un contrôleur .NET 6

Introduction

Dans le développement d'applications web modernes, il est courant d'utiliser des API RESTful pour communiquer entre les clients et les serveurs. .NET 6 offre un framework robuste pour la création d'API RESTful performantes et faciles à maintenir. Un élément crucial de ces API est la capacité de retourner des données JSON au client.

Retourner des données JSON avec les contrôleurs .NET 6

.NET 6 fournit un moyen simple de retourner des données JSON à partir de vos contrôleurs. Voici comment :

Définir un modèle de données: Commencez par définir une classe représentant les données que vous souhaitez retourner en JSON.

public class Product
{
    public int Id { get; set; }
    public string Name { get; set; }
    public decimal Price { get; set; }
}

Créer un contrôleur: Créez un contrôleur avec une action qui retourne une instance de votre modèle de données.

[ApiController]
[Route("[controller]")]
public class ProductsController : ControllerBase
{
    [HttpGet]
    public IActionResult GetProduct()
    {
        // Créer un exemple de produit
        var product = new Product { Id = 1, Name = "Produit 1", Price = 10.99m };

        // Retourner le produit en JSON
        return Ok(product);
    }
}

Sérialisation automatique: .NET 6 se charge automatiquement de sérialiser l'objet Product en JSON. Le framework utilise le format JSON par défaut pour la sérialisation.

Points importants à retenir:

Ok(): La méthode Ok() du contrôleur retourne un code HTTP 200 OK avec le corps de la réponse contenant le JSON sérialisé.
Autres codes HTTP: Vous pouvez utiliser d'autres méthodes du contrôleur pour retourner des codes HTTP différents, par exemple, NotFound() pour un code 404 ou BadRequest() pour un code 400.
Personnalisation: Vous pouvez personnaliser le format JSON en utilisant des attributs comme [JsonPropertyName] pour renommer les propriétés ou [JsonIgnore] pour ignorer des propriétés spécifiques.

Exemple complet

Voici un exemple complet d'un contrôleur .NET 6 qui retourne des données JSON :

using Microsoft.AspNetCore.Mvc;

namespace MyAPI.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class ProductsController : ControllerBase
    {
        [HttpGet]
        public IActionResult GetProduct()
        {
            // Créer un exemple de produit
            var product = new Product { Id = 1, Name = "Produit 1", Price = 10.99m };

            // Retourner le produit en JSON
            return Ok(product);
        }
    }

    public class Product
    {
        public int Id { get; set; }
        public string Name { get; set; }
        public decimal Price { get; set; }
    }
}

Conclusion

Retourner des données JSON à partir de contrôleurs .NET 6 est une opération simple et directe. La sérialisation automatique offerte par le framework vous permet de concentrer vos efforts sur la logique métier et de simplifier le développement de vos API RESTful.