Scalar.AspNetCore 2.0.33

Scalar .NET API Reference Integration

This .NET package Scalar.AspNetCore provides an easy way to render beautiful API references based on OpenAPI/Swagger documents.

Made possible by the wonderful work of @captainsafia on building the integration and docs written for the Scalar & .NET integration. Thanks to @xC0dex for making it awesome.

Migration Guide

If you are upgrading from 1.x.x to 2.x.x, please refer to the migration guide.

Usage

1. Install the package

dotnet add package Scalar.AspNetCore --version 2.0.*

[!NOTE] We release new versions frequently to bring you the latest features and bug fixes. To reduce the noise in your project file, we recommend using a wildcard for the patch version, e.g., 2.0.*.

2. Add the using directive

using Scalar.AspNetCore;

3. Configure your application

Add the following to Program.cs based on your OpenAPI generator:

For .NET 9 using Microsoft.AspNetCore.OpenApi:

builder.Services.AddOpenApi();

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

For .NET 8 using Swashbuckle:

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

if (app.Environment.IsDevelopment())
{
    app.UseSwagger(options =>
    {
        options.RouteTemplate = "/openapi/{documentName}.json";
    });
    app.MapScalarApiReference();
}

For .NET 8 using NSwag:

builder.Services.AddEndpointsApiExplorer();
builder.Services.AddOpenApiDocument();

if (app.Environment.IsDevelopment())
{
    app.UseOpenApi(options =>
    {
        options.Path = "/openapi/{documentName}.json";
    });
    app.MapScalarApiReference();
}

That’s it! 🎉 With the default settings, you can now access the Scalar API reference at /scalar to see the API reference for the v1 document. Alternatively, you can navigate to /scalar/{documentName} (e.g., /scalar/v2) to view the API reference for a specific document.

Configuration

For a full configuration guide and examples, including OAuth integration and custom settings, refer to the dotnet integration documentation.

Development

Local

1. Download .NET 9.0
2. Jump to the package folder: cd integrations/aspnetcore
3. Do a fresh build: dotnet build
4. Run the tests: dotnet test

And see it in action here:

1. Switch to the playground: cd playground/Scalar.AspNetCore.Playground
2. Start the playground: dotnet run
3. Open this URL in the browser: http://localhost:5056/scalar/

Docker

If you don't have the SDK installed or want to run the playground under a subpath, you can use Docker Compose:

1. Run Docker Compose: docker compose up --build
2. Open this URL in the browser: http://localhost:8080/api/scalar/

Community

We are API nerds. You too? Let’s chat on Discord: https://discord.gg/scalar

License

The source code in this repository is licensed under MIT.