Scalar.AspNetCore 2.2.7

There is a newer version of this package available.
See the version list below for details.
dotnet add package Scalar.AspNetCore --version 2.2.7
                    
NuGet\Install-Package Scalar.AspNetCore -Version 2.2.7
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Scalar.AspNetCore" Version="2.2.7" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Scalar.AspNetCore" Version="2.2.7" />
                    
Directory.Packages.props
<PackageReference Include="Scalar.AspNetCore" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Scalar.AspNetCore --version 2.2.7
                    
#r "nuget: Scalar.AspNetCore, 2.2.7"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=Scalar.AspNetCore&version=2.2.7
                    
Install Scalar.AspNetCore as a Cake Addin
#tool nuget:?package=Scalar.AspNetCore&version=2.2.7
                    
Install Scalar.AspNetCore as a Cake Tool

Scalar .NET API Reference Integration

Version Downloads Discord

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.

Features

  • Stunning API Reference
  • Compatible with .NET 8 and above
  • Independent of OpenAPI document generators
  • Fully AOT (Ahead-of-Time) compatible

dotnet

Migration Guide

If you are upgrading from 2.1.x to 2.2.x, please refer to the 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
  1. Add the using directive
using Scalar.AspNetCore;
  1. Configure your application

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

For Microsoft.AspNetCore.OpenApi:

builder.Services.AddOpenApi();

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

For Swashbuckle:

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

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

For NSwag:

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

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

For FastEndpoints:

builder.Services.SwaggerDocument();

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

You’re all set! 🎉 Visit /scalar to see the API Reference for the default OpenAPI document (v1).

If you have multiple OpenAPI documents, you can set them up with AddDocument or AddDocuments (see Multiple OpenAPI Documents).
To view a specific document, go to /scalar/{documentName} (like /scalar/v1 or /scalar/v2-beta).

Configuration

For detailed configuration options, refer to the integration documentation. This documentation focuses on the features provided by the package.

For more realistic examples and advanced usage scenarios, such as authentication, API versioning, and handling multiple documents, check out our extended examples documentation. This documentation is also useful if you need more context on what Scalar.AspNetCore is for.

OpenAPI extensions

Scalar provides additional packages to enhance OpenAPI document generation:

  • Scalar.AspNetCore.Microsoft: Implements transformers for Microsoft.AspNetCore.OpenApi
  • Scalar.AspNetCore.Swashbuckle: Implements filters for Swashbuckle

These packages enable advanced features like stability indicators and API Reference exclusions. See the dotnet integration documentation for details.

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.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net8.0

    • No dependencies.
  • net9.0

    • No dependencies.

NuGet packages (46)

Showing the top 5 NuGet packages that depend on Scalar.AspNetCore:

Package Downloads
Rystem.Api.Server

Rystem.Api helps you to integrate Api Server and Automated Client for Aspect-Oriented programming.

devprime.stack.web

DevPrime Web

Mii.Rinjani.Gateway.Commons

Package Description

ShayganTadbir.Framework.Core

Package description

NForza.Cyrus.Core

Opiniated source generation framework for CQRS webapps

GitHub repositories (33)

Showing the top 20 popular GitHub repositories that depend on Scalar.AspNetCore:

Repository Stars
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
dotnet/eShop
A reference .NET application implementing an eCommerce site
davidfowl/TodoApp
Todo application with ASP.NET Core Blazor WASM, Minimal APIs and Authentication
webprofusion/certify
Professional ACME Client for Windows. Certificate Management UI, powered by Let's Encrypt and compatible with all ACME v2 CAs. Used by over 150,000 organisations. Remember to Star us! Download from certifytheweb.com
GZTimeWalker/GZCTF
The GZ::CTF project, an open source CTF platform.
grandnode/grandnode2
E-commerce platform built with ASP.NET Core using MongoDB for NoSQL storage
meysamhadeli/monolith-to-cloud-architecture
A practical architecture styles for migrating from monolith to modern cloud native application with the latest technologies and architectures like Vertical Slice Architecture, Event Sourcing, CQRS, DDD, gRpc, MongoDB, RabbitMq, and Masstransit in .Net 9.
SteveDunn/Vogen
A semi-opinionated library which is a source generator and a code analyser. It Source generates Value Objects
AIDotNet/OpenDeepWiki
OpenDeepWiki is the open-source version of the DeepWiki project, aiming to provide a powerful knowledge management and collaboration platform. The project is mainly developed using C# and TypeScript, supporting modular design, and is easy to expand and customize.
erwinkramer/bank-api
The Bank API is a design reference project suitable to bootstrap development for a compliant and modern API.
jeangatto/ASP.NET-Core-Clean-Architecture-CQRS-Event-Sourcing
ASP.NET Core, C#, CQRS Event Sourcing, REST API, DDD, SOLID Principles and Clean Architecture
meysamhadeli/booking-modular-monolith
Practical Modular Monolith, built with .Net 9, DDD, CQRS, Vertical Slice Architecture, Event-Driven Architecture, and the latest technologies.
codewithmukesh/dotnet-webapi-zero-to-hero-course
Learn .NET Web APIs the Right Way – From Basics to Production-Ready!
platformplatform/PlatformPlatform
A platform designed for building enterprise-grade, multi-tenant products using Azure, .NET, React, TypeScript, Infrastructure as Code, etc.
LANCommander/LANCommander
mehdihadeli/vertical-slice-api-template
🍰 An asp.net core template based on .Net 9, Vertical Slice Architecture, CQRS, Minimal APIs, OpenTelemetry, API Versioning and OpenAPI.
SteveDunn/Intellenum
Intelligent Enums
androidseb25/iGotify-Notification-Assistent
Docker container for sending Gotify notifications to iOS devices (bridge to gotify websocket)
mikolaj-jankowski/Clean-Architecture-And-Domain-Driven-Design-Solution-Template
.NET Core template in DDD and Clean Architecture approach.
FormCms/FormCms
Open-source headless CMS built with ASP.NET Core (C#) and React, featuring REST APIs, GraphQL, and a GrapesJS page designer.
Version Downloads Last updated
2.4.4 4,236 5/27/2025
2.4.3 13,516 5/23/2025
2.4.2 6,417 5/22/2025
2.4.1 5,299 5/22/2025
2.3.1 39,004 5/15/2025
2.3.0 28,972 5/12/2025
2.2.7 71,184 5/5/2025
2.2.5 27,568 5/1/2025
2.2.4 3,196 5/1/2025
2.2.3 4,424 4/30/2025
2.2.2 10,677 4/29/2025
2.2.1 56,749 4/24/2025
2.2.0 4,215 4/23/2025
2.1.18 18,483 4/22/2025
2.1.17 34,376 4/18/2025
2.1.16 14,755 4/16/2025
2.1.15 3,466 4/16/2025
2.1.14 1,778 4/16/2025
2.1.13 341,011 4/11/2025
2.1.12 2,637 4/11/2025
2.1.11 17,083 4/10/2025
2.1.10 5,728 4/10/2025
2.1.9 16,370 4/9/2025
2.1.8 15,372 4/8/2025
2.1.7 16,559 4/7/2025
2.1.6 23,779 4/4/2025
2.1.5 20,772 4/2/2025
2.1.4 36,789 3/31/2025
2.1.3 27,819 3/28/2025
2.1.2 24,306 3/26/2025
2.1.1 151,954 3/20/2025
2.1.0 33,404 3/19/2025
2.0.36 69,146 3/15/2025
2.0.34 7,035 3/14/2025
2.0.33 4,115 3/14/2025
2.0.30 34,653 3/12/2025
2.0.29 28,894 3/10/2025
2.0.28 2,591 3/10/2025
2.0.27 13,411 3/10/2025
2.0.26 30,961 3/7/2025
2.0.25 9,903 3/6/2025
2.0.24 14,000 3/6/2025
2.0.23 95,782 3/4/2025
2.0.22 15,299 3/3/2025
2.0.21 19,630 3/2/2025
2.0.20 17,059 2/28/2025
2.0.19 3,311 2/28/2025
2.0.18 177,122 2/21/2025
2.0.17 3,881 2/20/2025
2.0.16 10,386 2/20/2025
2.0.15 29,648 2/18/2025
2.0.14 48,659 2/13/2025
2.0.12 86,489 2/6/2025
2.0.11 36,677 2/4/2025
2.0.10 5,173 2/4/2025
2.0.9 58,220 1/30/2025
2.0.8 2,247 1/30/2025
2.0.7 22,115 1/28/2025
2.0.6 2,261 1/28/2025
2.0.5 14,315 1/27/2025
2.0.4 44,156 1/22/2025
2.0.2 33,404 1/20/2025
2.0.1 33,658 1/17/2025
2.0.0 5,268 1/16/2025
1.2.76 84,669 1/13/2025
1.2.75 13,892 1/11/2025
1.2.74 41,433 1/8/2025
1.2.73 7,228 1/7/2025
1.2.72 68,137 12/24/2024
1.2.71 5,666 12/23/2024
1.2.70 7,274 12/22/2024
1.2.69 1,744 12/22/2024
1.2.68 3,315 12/21/2024
1.2.67 1,002 12/20/2024
1.2.66 7,728 12/20/2024
1.2.65 880 12/19/2024
1.2.64 16,646 12/18/2024
1.2.63 7,389 12/18/2024
1.2.61 3,997 12/17/2024
1.2.60 4,019 12/17/2024
1.2.59 705 12/17/2024
1.2.58 525 12/16/2024
1.2.57 1,490 12/16/2024
1.2.56 18,310 12/15/2024
1.2.55 6,479 12/13/2024
1.2.54 855 12/13/2024
1.2.53 12,580 12/11/2024
1.2.52 1,238 12/11/2024
1.2.51 15,485 12/10/2024
1.2.50 8,046 12/9/2024
1.2.49 18,073 12/6/2024
1.2.48 6,991 12/5/2024
1.2.47 7,549 12/4/2024
1.2.46 1,341 12/4/2024
1.2.45 83,977 11/27/2024
1.2.44 34,497 11/23/2024
1.2.43 1,588 11/22/2024
1.2.42 30,823 11/21/2024
1.2.41 49,495 11/20/2024
1.2.40 1,032 11/19/2024
1.2.39 17,199 11/17/2024
1.2.38 456 11/16/2024
1.2.37 14,050 11/14/2024
1.2.36 23,202 11/13/2024
1.2.35 2,498 11/12/2024
1.2.34 21,660 11/10/2024
1.2.33 2,819 11/8/2024
1.2.32 406 11/7/2024
1.2.31 6,571 11/6/2024
1.2.30 2,248 11/4/2024
1.2.29 7,266 11/1/2024
1.2.28 1,090 11/1/2024
1.2.27 11,035 10/30/2024
1.2.26 5,950 10/30/2024
1.2.25 3,594 10/29/2024
1.2.24 1,591 10/28/2024
1.2.23 5,948 10/27/2024
1.2.22 5,038 10/24/2024
1.2.21 3,636 10/23/2024
1.2.20 729 10/22/2024
1.2.19 196 10/22/2024
1.2.18 6,206 10/20/2024
1.2.17 616 10/20/2024
1.2.16 950 10/19/2024
1.2.15 668 10/19/2024
1.2.14 299 10/18/2024
1.2.13 288 10/18/2024
1.2.12 1,027 10/18/2024
1.2.11 304 10/17/2024
1.2.10 5,045 10/17/2024
1.2.9 24,974 10/7/2024
1.2.8 576 10/7/2024
1.2.7 1,048 10/3/2024
1.2.6 301 10/2/2024
1.2.5 1,863 9/28/2024
1.2.4 4,257 9/22/2024
1.2.3 7,240 9/6/2024
1.1.2 13,755 7/18/2024
1.1.1 5,799 5/21/2024
1.0.1 718 5/15/2024