.NET 7: Document endpoint descriptions and summaries for minimal APIs

[Rick-Anderson]

endpoint descriptions and summaries for minimal APIs

using Microsoft.AspNetCore.OpenApi;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseHttpsRedirection();

var summaries = new[]
{
    "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
};

app.MapGet("/", [EndpointSummary("Sends a Hello request to the backend")]   // <----
[EndpointDescription("Description: Sends hello request")] () => "Hello World!");   // <----

app.MapGet("/weatherforecast", () =>
{
    var forecast = Enumerable.Range(1, 5).Select(index =>
        new WeatherForecast
        (
            DateTime.Now.AddDays(index),
            Random.Shared.Next(-20, 55),
            summaries[Random.Shared.Next(summaries.Length)]
        ))
        .ToArray();
    return forecast;
})
.WithDescription("Description:Sends the weather forcast.")         // <----
.WithSummary("Summary: Sends the weather forcast.")   // <----
.WithName("GetWeatherForecast")
.WithOpenApi();

app.Run();

internal record WeatherForecast(DateTime Date, int TemperatureC, string? Summary)
{
    public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
}

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: ed83a5ff-cb3a-8655-9f9a-a441da52424e
• Version Independent ID: ed83a5ff-cb3a-8655-9f9a-a441da52424e
• Content: What's new in ASP.NET Core 7.0
• Content Source: aspnetcore/release-notes/aspnetcore-7.0.md
• Product: aspnet-core
• Technology: aspnetcore-releasenotes
• GitHub Login: @Rick-Anderson
• Microsoft Alias: riande

[Rick-Anderson]

@martincostello should this be postponed until dotnet/aspnetcore#40753 is closed?

@hwoodiwiss writes

Due to the changes to CI that will be required, it may have to wait until a bit closer to .NET 7's Release before it gets merged.

[martincostello]

I guess so if it still doesn't work as expected.