Création de votre première API minimale à l’aide de .NET 6 et C#

Introduction

Utilisation minimale de l’API .NET et C# offrent une approche rapide, légère et moderne pour créer des API HTTP en utilisant une configuration minimale et un code passe-partout. Introduit dans .NET6Les API minimales sont devenues de plus en plus populaires pour microservices, applications cloud nativeset prototypage rapide en raison de leur simplicité et de leurs performances. Dans ce blog, vous apprendrez à créer un API minimale étape par étape utilisant .NET et C#configurez les points de terminaison et exécutez votre premier projet d’API léger.

Conditions préalables à la création d’une API minimale dans .NET 6

Avant de commencer, assurez-vous d’avoir :

• SDK .NET installé (version 6 ou ultérieure)
• Un éditeur de code (comme Visual Studio, VS Code ou JetBrains Rider)
• Connaissance de base de C#, API RESTet Méthodes HTTP

Création d’une API minimale à l’aide de la configuration du projet .NET 6 et C#

Ouvrez votre terminal ou votre invite de commande et créez un nouveau projet API Minimal à l’aide de la commande suivante :

dotnet new web -n MinimalApiDemo

Fondamentalement, cette commande crée un nouveau projet Web nommé MinimalApiDémo.

• Accédez au répertoire du projet

cd MinimalApiDemo

• Ouvrez le projet dans votre éditeur

À l’étape suivante, ouvrez le projet dans votre éditeur de code préféré pour explorer et travailler avec les fichiers.

Définir le modèle dans une API minimale

Commençons par créer un modèle simple pour un élément Todo. Dans votre dossier de projet, créez un nouveau fichier appelé TodoItem.cs et ajoutez le code ci-dessous :

public class TodoItem 
{ 
    public int Id { get; set; } 
    public string? Title { get; set; } 
    public bool IsCompleted { get; set; } 
} 

Configuration des points de terminaison d’API à l’aide de .NET 6 et C#

Définissons maintenant les points de terminaison de l’API qui géreront diverses requêtes HTTP. Pour ce faire, ouvrez le Programme.cs fichier et remplacez ou mettez à jour le code existant avec l’exemple ci-dessous :

var builder = WebApplication.CreateBuilder(args); 
var app = builder.Build(); 
 
List<TodoItem> todos = new(); 
 
app.MapGet("/todos", () => todos); 
 
app.MapGet("/todos/{id}", (int id) => 
    todos.FirstOrDefault(t => t.Id == id) 
); 
 
app.MapPost("/todos", (TodoItem todo) => 
{ 
    todo.Id = todos.Count + 1; 
    todos.Add(todo); 
    return Results.Created($"/todos/{todo.Id}", todo); 
}); 
 
app.MapPut("/todos/{id}", (int id, TodoItem updatedTodo) => 
{ 
    var todo = todos.FirstOrDefault(t => t.Id == id); 
    if (todo is null) return Results.NotFound(); 
 
    todo.Title = updatedTodo.Title; 
    todo.IsCompleted = updatedTodo.IsCompleted; 
 
    return Results.Ok(todo); 
}); 
 
app.MapDelete("/todos/{id}", (int id) => 
{ 
    var todo = todos.FirstOrDefault(t => t.Id == id); 
    if (todo is null) return Results.NotFound(); 
 
    todos.Remove(todo); 
    return Results.NoContent(); 
}); 
 
app.Run(); 

Explication du Code

Injection de dépendance

Nous utilisons une liste singleton pour stocker TodoItem objets, fournissant un mécanisme simple de stockage en mémoire à des fins de démonstration.

Points de terminaison de l’API

• OBTENIR /tout → Récupérer toutes les tâches
• OBTENIR /todos/{id} → Obtenir une tâche à faire par ID
• PUBLIER /tous → Créer une nouvelle tâche
• METTRE /todos/{id} → Mettre à jour une tâche à effectuer
• SUPPRIMER /todos/{id} → Supprimer chaque élément

Exécuter l’API

En gros, pour exécuter l’API, exécutez la commande suivante dans votre terminal :

dotnet run

Une fois l’application lancée, votre API sera accessible sur http://localhost:5000. Vous pouvez tester les points de terminaison à l’aide d’outils tels que Facteur ou boucle.

Exécuter et tester l’API minimale

Exemples de demandes

• Créer un nouvel élément Todo à l’aide d’une requête POST

curl -X POST  -H "Content-type: application/json" -d '{"title": "Learn Minimal APIs", "isCompleted": false}'

• Ensuite, nous récupérerons tous les éléments Todo à l’aide d’une requête GET

curl -X GET /1 -H "Content-type: application/json" -d '{"title": "Learn Minimal APIs", "isCompleted": true}'

• Modifier un élément de tâche existant

curl -X PUT /1 -H "Content-type: application/json" -d '{"title": "Learn Minimal APIs", "isCompleted": true}'
curl -X DELETE /1
Conclusion
L'API minimale utilisant .NET offre un moyen propre, rapide et efficace de créer des services à petite échelle sans la surcharge des contrôleurs traditionnels. Ils sont parfaits pour microservices, applications cloud natives, prototypageet des scénarios où les performances et la simplicité comptent.
Avec seulement quelques lignes de code C#, vous pouvez créer des points de terminaison entièrement fonctionnels, les tester rapidement et passer de simples démos à des services prêts pour la production.
Que vous soyez débutant ou développeur .NET expérimenté, les API Minimal sont un ajout puissant à votre boîte à outils de développement.