Créer une API Web .NET Core pour traiter des requêtes POST avec JSON dans le corps
Introduction
Cet article explique comment créer une API Web .NET Core qui peut recevoir des données JSON dans le corps d'une requête POST et les traiter. Nous allons utiliser .NET Core et JSON.NET pour la sérialisation et la désérialisation des données JSON.
Créer un projet .NET Core
Commencez par créer un nouveau projet .NET Core. Sélectionnez "API Web ASP.NET Core" comme type de projet. Vous pouvez le nommer comme vous le souhaitez, par exemple "MyWebAPI".
Définir le modèle de données
Créez un modèle de données pour représenter les données que vous allez recevoir dans le corps de la requête POST. Par exemple, vous pouvez créer une classe nommée "Product" avec les propriétés suivantes :
public class Product
{
public int Id { get; set; }
public string Name { get; set; }
public decimal Price { get; set; }
}
Créer un contrôleur d'API
Créez un nouveau contrôleur d'API appelé "ProductsController". Ce contrôleur contiendra la logique pour gérer les requêtes POST.
[ApiController]
[Route("api/[controller]")]
public class ProductsController : ControllerBase
{
[HttpPost]
public IActionResult CreateProduct([FromBody] Product product)
{
// Traiter les données du produit ici
// Par exemple, enregistrer le produit dans une base de données
return Ok(product);
}
}
Attributs du contrôleur
- [ApiController] : Indique que ce contrôleur est un contrôleur d'API.
- [Route("api/[controller]")] : Définit l'itinéraire de base pour le contrôleur.
Attribut de l'action
- [HttpPost] : Indique que cette action gère les requêtes POST.
- [FromBody] : Indique que les données JSON seront lues à partir du corps de la requête et désérialisées dans un objet de type
Product
.
Traiter les données
Dans le code du contrôleur, vous pouvez accéder aux données du produit reçues à partir du corps de la requête via l'objet product
. Vous pouvez ensuite traiter ces données, par exemple, les enregistrer dans une base de données ou effectuer d'autres opérations.
Retourner une réponse
Enfin, vous pouvez renvoyer une réponse au client. Dans cet exemple, nous retournons un code de statut 200 OK
et l'objet product
en tant que JSON.
Tester l'API
Pour tester votre API, vous pouvez utiliser un outil comme Postman. Envoyez une requête POST à l'URL http://localhost:5000/api/products
avec un corps JSON contenant les données du produit.
{
"Id": 1,
"Name": "Produit 1",
"Price": 10.00
}
Vous devriez recevoir une réponse 200 OK avec les données du produit en tant que JSON.
Conclusion
En utilisant .NET Core et JSON.NET, vous pouvez facilement créer une API Web qui peut recevoir des données JSON dans le corps d'une requête POST et les traiter. N'oubliez pas de tester votre API pour vous assurer qu'elle fonctionne comme prévu.