C# Academy · Leçon

Générer des documents OpenAPI

Produisez des spécifications d’API lisibles par machine.

Générer des documents OpenAPI est une leçon C# Academy gratuite sur CoddyKit. Ceci est la leçon 3 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage C# Academy, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours C# Academy comprend 4 leçons au total.

Qu’est-ce qu’OpenAPI ?

OpenAPI est une description standard et lisible par machine d’une API HTTP. À partir de cette description, vous pouvez générer de la documentation, des kits de développement client et des outils de test.

.NET 9 intègre la génération de documents OpenAPI, ce qui remplace l’ancienne dépendance Swashbuckle dans de nombreuses applications.

// OpenAPI document = JSON describing paths, schemas, params

Le package Microsoft.AspNetCore.OpenApi

La prise en charge intégrée se trouve dans Microsoft.AspNetCore.OpenApi. Dans les modèles .NET 9, il est déjà référencé.

dotnet add package Microsoft.AspNetCore.OpenApi

AddOpenApi

Enregistrez le générateur de documents avec AddOpenApi dans la configuration de vos services.

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddOpenApi();

MapOpenApi

MapOpenApi publie le document généré sur un point de terminaison. Par défaut, il est disponible à l’adresse /openapi/v1.json.

var app = builder.Build();

app.MapOpenApi();   // GET /openapi/v1.json

app.Run();

Limiter au développement

Il est courant de publier le document uniquement en développement afin d’éviter d’exposer votre surface d’API en production.

if (app.Environment.IsDevelopment())
{
    app.MapOpenApi();
}

Décrire les points de terminaison

Les métadonnées OpenAPI sont enrichies à partir de votre code. Utilisez WithSummary, WithDescription et WithTags sur les points de terminaison des API minimales.

app.MapGet("/products/{id}", (int id) => Results.Ok())
   .WithSummary("Get a product by id")
   .WithDescription("Returns a single product or 404.")
   .WithTags("Products");

Documenter les réponses

Déclarez les types de réponse et les codes d’état afin que le document les répertorie avec précision.

app.MapGet("/products/{id}", (int id) => Results.Ok())
   .Produces<Product>(StatusCodes.Status200OK)
   .Produces(StatusCodes.Status404NotFound);

Transformateurs de documents

Personnalisez l’ensemble du document — titre, version, serveurs — avec un transformateur de document transmis à AddOpenApi.

builder.Services.AddOpenApi(options =>
{
    options.AddDocumentTransformer((doc, ctx, ct) =>
    {
        doc.Info.Title = "Catalog API";
        doc.Info.Version = "1.0";
        return Task.CompletedTask;
    });
});

Transformateurs d’opérations

Un transformateur d’opération modifie des opérations individuelles — par exemple, en ajoutant un paramètre d’en-tête commun à chaque point de terminaison.

options.AddOperationTransformer((operation, ctx, ct) =>
{
    operation.Responses.TryAdd("500",
        new OpenApiResponse { Description = "Server error" });
    return Task.CompletedTask;
});

Ajouter une interface

Le générateur intégré produit le document JSON, mais aucune interface. Associez-lui un visualiseur comme Scalar ou Swagger UI.

// dotnet add package Scalar.AspNetCore
app.MapOpenApi();
app.MapScalarApiReference();  // interactive docs at /scalar/v1

Générer lors de la compilation

Vous pouvez produire le fichier OpenAPI pendant la compilation, sans serveur en cours d’exécution, à l’aide des outils Microsoft.Extensions.ApiDescription.Server, ce qui est pratique pour générer des clients dans une chaîne d’intégration continue.

// .csproj
// <OpenApiGenerateDocuments>true</OpenApiGenerateDocuments>
// produces obj/<App>.json on build

Vérification rapide

Vérifiez les notions fondamentales d’OpenAPI dans .NET 9.

Récapitulatif

Vous avez généré des documents OpenAPI :

AddOpenApi() enregistre le générateur ; MapOpenApi() publie le document JSON.
Enrichissez les points de terminaison avec WithSummary, Produces et des balises.
Les transformateurs de documents et d’opérations personnalisent le résultat.
Associez-les à Scalar ou Swagger UI pour obtenir une vue interactive.

Ensuite : documenter les API dont les versions sont gérées.

Questions Fréquemment Posées

La leçon « Générer des documents OpenAPI » est-elle gratuite ?

Oui — le texte complet de « Générer des documents OpenAPI » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours C# Academy, passe à CoddyKit PRO. Le cours C# Academy comprend 4 leçons au total.

Qu'est-ce que j'apprendrai dans « Générer des documents OpenAPI » ?

Produisez des spécifications d’API lisibles par machine. Tu pratiques C# Academy avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.

Dois-je avoir de l'expérience pour commencer C# Academy ?

Aucune expérience préalable n'est requise. C# Academy sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 3 sur 4.

Combien de temps prend la leçon « Générer des documents OpenAPI » ?

La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.

Peux-tu écrire et exécuter du code dans cette leçon C# Academy ?

Oui. Chaque leçon C# Academy inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.

Toutes les leçons de ce cours

← Retour à C# Academy