InfluencesMag.org
Home

.net Core 3.1 Api Example

5 min read Jun 03, 2024
.net Core 3.1 Api Example

Créer une API REST avec ASP.NET Core 3.1 : Un exemple simple

ASP.NET Core 3.1 est un framework open-source puissant pour la création d'applications web et d'API REST. Il est léger, rapide et offre une grande flexibilité. Dans cet exemple, nous allons construire une API REST simple pour gérer une liste de produits.

Configuration de l'environnement

Avant de commencer, assurez-vous d'avoir installé les éléments suivants :

  • .NET Core SDK 3.1 : Vous pouvez le télécharger depuis le site officiel de Microsoft.
  • Visual Studio Code ou Visual Studio : Un IDE est recommandé pour le développement.

Créer un nouveau projet

  1. Ouvrez votre terminal ou ligne de commande.
  2. Exécutez la commande suivante pour créer un nouveau projet ASP.NET Core :
dotnet new webapi -o MyFirstAPI

Remplacez "MyFirstAPI" par le nom de votre projet.

Définir le modèle de données

  1. Créez un nouveau fichier nommé "Product.cs" dans le dossier "Models".
  2. Ajoutez le code suivant pour définir le modèle de produit :
using System.ComponentModel.DataAnnotations;

namespace MyFirstAPI.Models
{
    public class Product
    {
        [Key]
        public int Id { get; set; }

        [Required]
        public string Name { get; set; }

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

        public string Description { get; set; }
    }
}

Ce modèle définit les propriétés nécessaires pour un produit : Id, Name, Price et Description.

Créer le contrôleur API

  1. Créez un nouveau fichier nommé "ProductsController.cs" dans le dossier "Controllers".
  2. Ajoutez le code suivant pour définir le contrôleur API :
using Microsoft.AspNetCore.Mvc;
using MyFirstAPI.Models;
using System.Collections.Generic;

namespace MyFirstAPI.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class ProductsController : ControllerBase
    {
        private readonly List _products = new List()
        {
            new Product { Id = 1, Name = "Produit A", Price = 10.99, Description = "Description du Produit A" },
            new Product { Id = 2, Name = "Produit B", Price = 29.99, Description = "Description du Produit B" }
        };

        // GET: api/Products
        [HttpGet]
        public ActionResult> GetProducts()
        {
            return _products;
        }

        // GET: api/Products/5
        [HttpGet("{id}")]
        public ActionResult GetProduct(int id)
        {
            var product = _products.FirstOrDefault(p => p.Id == id);
            if (product == null)
            {
                return NotFound();
            }
            return product;
        }
    }
}

Ce contrôleur expose deux méthodes :

  • GetProducts() : Renvoie la liste de tous les produits.
  • GetProduct(int id) : Renvoie un produit spécifique en fonction de son identifiant.

Lancer l'application

  1. Ouvrez votre terminal ou ligne de commande.
  2. Naviguez jusqu'au répertoire de votre projet.
  3. Exécutez la commande suivante pour lancer l'application :
dotnet run

Tester l'API

Une fois l'application lancée, vous pouvez tester l'API avec un outil de votre choix. Vous pouvez utiliser un client HTTP comme Postman ou curl.

Par exemple, pour récupérer la liste de tous les produits, envoyez une requête GET à l'URL suivante :

http://localhost:5000/api/Products

Vous devriez obtenir une réponse JSON contenant la liste des produits.

N'oubliez pas que cet exemple est basique et ne couvre pas toutes les fonctionnalités d'ASP.NET Core 3.1. Il vous donne une idée de la structure de base d'une API REST simple.

Pour aller plus loin, vous pouvez explorer les fonctionnalités suivantes :

  • Création, mise à jour et suppression de produits.
  • Authentification et autorisation.
  • Intégration avec une base de données.
  • Gestion des erreurs et des exceptions.

En utilisant ASP.NET Core 3.1, vous pouvez facilement créer des API REST performantes et scalables pour vos applications web.

Featured Posts