Scalar

Scalar fournit une interface web pour tester notre service.

On l’active en installant un paquet NuGet.

Pour cela, lancez cette commande dans le dossier de votre projet (celui qui contient le fichier .csproj) :

dotnet add package Scalar.AspNetCore

Dans Program.cs, conservez les instructions de premier niveau utilisées par défaut et ajoutez la configuration Scalar. L’exemple complet ci-dessous enregistre OpenAPI et les contrôleurs, puis affiche Scalar en développement :

using Scalar.AspNetCore;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllers();
builder.Services.AddOpenApi();

var app = builder.Build();
if (app.Environment.IsDevelopment())
{
    app.MapOpenApi();
    app.MapScalarApiReference();
}

app.MapControllers();
app.Run();

Si vous avez choisi --use-program-main lors de la création du projet, placez les instructions de démarrage ci-dessus dans la méthode Main existante et gardez using Scalar.AspNetCore; en haut du fichier.

Pour lancer automatiquement scalar on modifie le fichier Properties/launchSettings.json. On passera launchBrowser à true et launchUrl à scalar/v1 :

{
  "$schema": "https://json.schemastore.org/launchsettings.json",
  "profiles": {
    "http": {
      "commandName": "Project",
      "dotnetRunMessages": true,
      "launchBrowser": true,
      "applicationUrl": "http://localhost:5000",
      "launchUrl": "scalar/v1",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }
}

Conservez les autres réglages utiles de votre profil existant. Le port 5000 correspond à celui de la semaine 1 ; adaptez-le si vous en avez choisi un autre. L’environnement Development permet d’activer le bloc qui expose OpenAPI et Scalar.