.net 6 Api Controller Example

INFLUENCESMAG.ORG

4 min read

·

Jun 03, 2024

29

Share

Créez un contrôleur d'API avec .NET 6

Cet article vous guidera à travers la création d'un contrôleur d'API simple en utilisant .NET 6. Les contrôleurs d'API sont des composants essentiels pour la création d'applications web RESTful avec .NET. Ils gèrent les requêtes HTTP entrantes et renvoient des réponses aux clients.

Configuration du projet

1. Commencez par créer un nouveau projet ASP.NET Core dans Visual Studio ou à l'aide de l'interface de ligne de commande.
2. Sélectionnez le modèle "API Web" lors de la création du projet.
3. Assurez-vous que .NET 6 est sélectionné comme version du framework cible.

Création du contrôleur d'API

1. Ajoutez un nouveau contrôleur:

   • Cliquez avec le bouton droit sur le dossier "Controllers" dans votre projet et sélectionnez "Ajouter > Contrôleur".
   • Choisissez le modèle "Contrôleur API vide" et donnez-lui un nom (par exemple, "WeatherForecastController").

2. Ajoutez du code au contrôleur:

   • Ouvrez le fichier du contrôleur que vous venez de créer (par exemple, "WeatherForecastController.cs").

   • Ajoutez les références nécessaires, comme using Microsoft.AspNetCore.Mvc;.

   • Créez une classe nommée WeatherForecastController héritant de ControllerBase.

   • Définissez une méthode d'action pour gérer les requêtes HTTP. Par exemple:

     [HttpGet]
     public IEnumerable Get()
     {
         var forecasts = Enumerable.Range(1, 5).Select(index => new WeatherForecast
         {
             Date = DateTime.Now.AddDays(index),
             TemperatureC = Random.Shared.Next(-20, 55),
             Summary = Summaries[Random.Shared.Next(Summaries.Length)]
         })
         .ToArray();
         return forecasts;
     }
     
     private static readonly string[] Summaries = new[]
     {
         "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
     };
     

Explication du code

• [HttpGet] : Cet attribut indique que cette méthode gère les requêtes HTTP GET sur la route /weatherforecast.
• Get() : Nom de la méthode d'action.
• IEnumerable<WeatherForecast> : Type de retour de la méthode. Elle renvoie une collection de prévisions météorologiques.
• WeatherForecast : Classe modèle qui représente une prévision météorologique.
• Summaries : Tableau de chaînes de caractères représentant les résumés météorologiques possibles.

Lancer l'application

1. Exécutez votre application .NET 6.
2. Ouvrez un navigateur web et accédez à l'URL http://localhost:5000/weatherforecast.

Vous devriez voir une liste de prévisions météorologiques JSON en réponse, indiquant que votre contrôleur d'API fonctionne correctement.

Conclusion

Cet article vous a présenté un exemple simple de contrôleur d'API dans .NET 6. Vous pouvez construire des API plus complexes en ajoutant davantage de méthodes d'action pour gérer différents types de requêtes HTTP, en utilisant des attributs de route pour personnaliser les URL, et en implémentant des validations et des logiques métier dans vos contrôleurs.

N'oubliez pas que c'est une introduction basique, et vous pouvez explorer davantage de fonctionnalités et de concepts liés aux contrôleurs d'API dans la documentation officielle de .NET.