.net Core Web Api Controller Example

4 min read Jun 03, 2024

Créer un contrôleur Web API avec .NET Core : Un exemple simple

Cet article présente un exemple simple de création d'un contrôleur Web API avec .NET Core. Nous allons créer un contrôleur qui renvoie une liste de produits fictifs.

Prérequis

Visual Studio 2022 ou supérieur
.NET 6 SDK

Étapes

Création d'un nouveau projet .NET Core
- Ouvrez Visual Studio et créez un nouveau projet.
- Sélectionnez "ASP.NET Core Web Application" et cliquez sur "Suivant".
- Nommez votre projet (par exemple, "MyWebApi") et choisissez ".NET 6" comme version de framework.
- Sélectionnez "API Web" comme type de projet et cliquez sur "Créer".
Création du contrôleur
- Dans le dossier "Controllers", cliquez avec le bouton droit et sélectionnez "Ajouter" -> "Contrôleur".
- Choisissez "Contrôleur API" et cliquez sur "Ajouter".
- Nommez votre contrôleur "ProductController" et cliquez sur "Ajouter".

Implémentation du contrôleur

Ouvrez le fichier "ProductController.cs" et remplacez le code par le suivant :

using Microsoft.AspNetCore.Mvc;

namespace MyWebApi.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class ProductController : ControllerBase
    {
        [HttpGet]
        public IActionResult GetProducts()
        {
            var products = new List
            {
                new Product { Id = 1, Name = "Produit 1", Price = 10 },
                new Product { Id = 2, Name = "Produit 2", Price = 20 },
                new Product { Id = 3, Name = "Produit 3", Price = 30 }
            };
            return Ok(products);
        }
    }

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

Ce code définit un contrôleur avec une méthode GetProducts qui renvoie une liste de produits fictifs.

Exécution de l'application
- Appuyez sur F5 pour exécuter l'application.
- Ouvrez un navigateur Web et accédez à l'URL http://localhost:5000/product.
- Vous devriez voir la liste des produits renvoyée en format JSON.

Explication du code

[ApiController] : Attribut qui indique que la classe est un contrôleur Web API.
[Route("[controller]")] : Attribut qui définit la route du contrôleur. La valeur "[controller]" est remplacée automatiquement par le nom du contrôleur.
[HttpGet] : Attribut qui indique que la méthode est accessible via une requête HTTP GET.
IActionResult : Type de retour de la méthode. Il représente un résultat HTTP.
Ok(products) : Méthode qui renvoie un code HTTP 200 (OK) avec les produits en tant que corps de la réponse.

Conclusion

Cet exemple simple vous permet de créer un contrôleur Web API avec .NET Core et de renvoyer des données en format JSON. Vous pouvez ensuite étendre ce code pour implémenter d'autres fonctionnalités, telles que la création, la mise à jour et la suppression de produits.

Mots clés : .NET Core, Web API, Contrôleur, Exemple, JSON