Créer un Contrôleur d'API .NET : Un Exemple Simple
Dans le développement web moderne, les API (Application Programming Interfaces) jouent un rôle crucial. .NET, un framework puissant, offre des outils robustes pour créer des API efficaces.
Introduction aux Contrôleurs d'API .NET
Les contrôleurs d'API .NET sont les points d'entrée pour les requêtes HTTP vers votre API. Ils reçoivent les requêtes, traitent les données et renvoient des réponses aux clients.
Exemple Simple : Contrôleur de Produits
Prenons un exemple simple : un contrôleur d'API pour gérer des produits.
using Microsoft.AspNetCore.Mvc;
namespace MyAPI.Controllers
{
[ApiController]
[Route("[controller]")]
public class ProductsController : ControllerBase
{
private readonly List _products = new List()
{
new Product { Id = 1, Name = "Produit A", Price = 10.99 },
new Product { Id = 2, Name = "Produit B", Price = 25.50 }
};
[HttpGet]
public IActionResult GetAllProducts()
{
return Ok(_products);
}
[HttpGet("{id}")]
public IActionResult GetProductById(int id)
{
var product = _products.FirstOrDefault(p => p.Id == id);
if (product == null)
{
return NotFound();
}
return Ok(product);
}
// ... (autres méthodes pour ajouter, modifier, supprimer des produits)
}
public class Product
{
public int Id { get; set; }
public string Name { get; set; }
public double Price { get; set; }
}
}
Ce code définit un contrôleur ProductsController avec les méthodes suivantes :
GetAllProducts: Renvoie la liste de tous les produits.GetProductById: Renvoie un produit spécifique en fonction de son ID.
Explication du Code
[ApiController]: Attribut pour indiquer que la classe est un contrôleur d'API.[Route("[controller]")]: Attribut pour définir l'URL de base du contrôleur.HttpGet: Attribut pour définir la méthode HTTP pour les actions.IActionResult: Type de retour pour les actions du contrôleur.Ok: Méthode pour renvoyer une réponse HTTP 200 (OK).NotFound: Méthode pour renvoyer une réponse HTTP 404 (Non trouvé).
Exécution de l'API
Une fois que vous avez configuré votre projet .NET, vous pouvez exécuter votre API et accéder aux points d'accès définis dans le contrôleur. Par exemple, pour récupérer tous les produits, vous pouvez utiliser l'URL http://localhost:5000/products.
Conclusion
Cet exemple simple démontre comment créer un contrôleur d'API .NET. Vous pouvez l'étendre en ajoutant d'autres méthodes pour gérer d'autres opérations sur vos données, comme la création, la mise à jour et la suppression de produits. L'utilisation de contrôleurs d'API .NET vous permet de construire des API RESTful robustes et bien organisées.