InfluencesMag.org
Home

.net Framework Web Api Return Json

4 min read Jun 03, 2024
.net Framework Web Api Return Json

Retourner des données JSON avec ASP.NET Web API

L'un des avantages clés d'ASP.NET Web API est sa capacité à retourner des données dans différents formats, notamment JSON. JSON (JavaScript Object Notation) est devenu le format de données standard pour les API web, car il est léger, lisible par l'homme et facile à parser par les machines.

Configuration de la réponse JSON

Par défaut, ASP.NET Web API utilise le format JSON pour les réponses. Vous n'avez donc pas besoin de configurer explicitement le format de réponse. Cependant, vous pouvez modifier la configuration par défaut si nécessaire. Voici comment configurer la réponse JSON dans votre application Web API :

  1. Installer le package NuGet : Assurez-vous que le package NuGet Microsoft.AspNet.WebApi.Client est installé dans votre projet.
  2. Configurer le format de réponse par défaut : Dans votre fichier WebApiConfig.cs, vous pouvez configurer le format de réponse par défaut pour toutes les actions de contrôleur. Voici un exemple :
public static void Register(HttpConfiguration config)
{
    // ... autres configurations

    // Définit JSON comme format de réponse par défaut
    config.Formatters.JsonFormatter.SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/html")); 
}

Retourner des données JSON

Pour retourner des données JSON à partir d'une action de contrôleur, vous pouvez simplement renvoyer un objet C# :

[HttpGet]
public Product GetProduct(int id)
{
    // Récupérer le produit à partir de la base de données
    var product = new Product { Id = id, Name = "Produit 1", Price = 100 };

    // Renvoyer le produit en tant que JSON
    return product;
}

ASP.NET Web API serialisera automatiquement l'objet Product en JSON et le renverra au client.

Contrôle de la sérialisation JSON

ASP.NET Web API utilise le sérialiseur JSON Json.NET pour convertir les objets C# en JSON. Vous pouvez personnaliser la sérialisation JSON en utilisant des attributs sur vos classes ou en configurant le sérialiseur JSON.

Exemple d'utilisation d'attributs :

public class Product
{
    public int Id { get; set; }

    [JsonProperty("product_name")]
    public string Name { get; set; }

    [JsonIgnore]
    public decimal Price { get; set; }
}

Dans cet exemple, l'attribut JsonProperty est utilisé pour renommer le champ Name en product_name dans le JSON de sortie. L'attribut JsonIgnore est utilisé pour empêcher le champ Price d'être inclus dans la sortie JSON.

Conclusion

Retourner des données JSON avec ASP.NET Web API est simple et direct. En utilisant les fonctionnalités intégrées d'ASP.NET Web API, vous pouvez facilement créer des API qui renvoient des données JSON de manière efficace et cohérente. N'hésitez pas à utiliser ASP.NET Web API et JSON pour votre application web et améliorer votre expérience de développement.

Featured Posts