Créer un contrôleur API .NET Core pour les requêtes POST
Introduction
Dans le monde du développement web, les API RESTful sont devenues la norme pour la communication entre les applications. .NET Core offre un cadre puissant et flexible pour construire des API RESTful, et les contrôleurs API sont au cœur de ce processus. Cet article vous guidera à travers la création d'un contrôleur API .NET Core pour gérer les requêtes POST.
Créer un contrôleur API
Commencez par créer un nouveau projet ASP.NET Core Web API dans Visual Studio. Ensuite, ajoutez un nouveau contrôleur API à votre projet. Vous pouvez le faire en cliquant avec le bouton droit sur le dossier "Controllers" et en sélectionnant "Ajouter" > "Contrôleur" > "Contrôleur API vide". Donnez à votre contrôleur un nom significatif, par exemple "ArticlesController".
Exemple de code
Voici un exemple de code pour un contrôleur API .NET Core qui gère une requête POST pour créer un nouvel article :
using Microsoft.AspNetCore.Mvc;
namespace YourProjectName.Controllers
{
[Route("api/[controller]")]
[ApiController]
public class ArticlesController : ControllerBase
{
// Définir le modèle de l'article
public class Article
{
public int Id { get; set; }
public string Titre { get; set; }
public string Contenu { get; set; }
}
// Point d'extrémité pour créer un nouvel article
[HttpPost]
public IActionResult CreateArticle([FromBody] Article article)
{
// Valider les données de l'article
if (!ModelState.IsValid)
{
return BadRequest(ModelState);
}
// Logique pour enregistrer l'article dans la base de données (par exemple, à l'aide d'Entity Framework Core)
// Retourner une réponse HTTP 201 (Créé)
return CreatedAtAction(nameof(GetArticle), new { id = article.Id }, article);
}
// Point d'extrémité pour récupérer un article par ID (pour test)
[HttpGet("{id}")]
public IActionResult GetArticle(int id)
{
// Logique pour récupérer l'article de la base de données
// Retourner l'article si trouvé, sinon un 404 (Non trouvé)
return Ok(article);
}
}
}
Explication du code
- [Route("api/[controller]")] : Cette attribut définit la route de base du contrôleur. "[controller]" est remplacé par le nom du contrôleur, ce qui donne "api/Articles" dans ce cas.
- [ApiController] : Cet attribut active les conventions d'API Web, comme l'attribut [FromBody] pour les requêtes POST.
- [HttpPost] : Cette attribut spécifie que cette méthode gère les requêtes POST.
- [FromBody] Article article : Cet attribut indique que les données de l'article doivent être envoyées dans le corps de la requête et seront automatiquement mappées à l'objet Article.
- ModelState.IsValid : Cette propriété vérifie si les données de l'article sont valides.
- return BadRequest(ModelState) : Si les données ne sont pas valides, un code d'état HTTP 400 (Mauvaise requête) est retourné avec les erreurs de validation.
- CreatedAtAction() : Cette méthode retourne un code d'état HTTP 201 (Créé) et inclut l'URL pour accéder au nouvel article dans l'en-tête de la réponse.
Conclusion
Ce tutoriel vous a montré comment créer un contrôleur API .NET Core pour gérer les requêtes POST. En utilisant les attributs et les méthodes appropriés, vous pouvez gérer les données entrantes, valider les données, et retourner des réponses HTTP appropriées. N'oubliez pas d'inclure la logique métier nécessaire pour enregistrer les données dans la base de données ou effectuer d'autres actions.
Mots clés: .NET Core, API, Contrôleur API, Requête POST, Création d'articles, API RESTful, Validation de données.