Skip to content
bekov0004 edited this page Sep 13, 2026 · 3 revisions

Folio.AspNetCore

An embeddable OpenAPI documentation and testing UI for ASP.NET Core, packaged as middleware — no separate infrastructure, no static hosting, just a NuGet package.

dotnet add package Folio.AspNetCore
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddOpenApi();

var app = builder.Build();

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

app.UseFolio(options =>
{
    options.SpecUrl = "/openapi/v1.json";
    options.Title   = "My API"; // optional
});

app.Run();

Open /folio (or your configured RoutePrefix) and you'll see the endpoint list, model schemas, a type-aware request builder, in-browser request execution with generated code snippets, environment support, and authorization against the spec's security schemes.

Where to go next

  • Features — what the UI itself can do: request building, code generation, environments, authorization, saved examples, and more.
  • Getting Started — installation, wiring up the spec source (built-in Microsoft.AspNetCore.OpenApi, Swashbuckle, NSwag, or a static file), and the full FolioOptions reference.
  • Authorization — gating the Folio UI behind a login, either integrating with your app's existing auth or using the self-contained AddFolioAuth()/UseFolioAuth().
  • FAQ — common questions and gotchas.

Links

Clone this wiki locally