Scalar.AspNetCore 1.2.44

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Scalar.AspNetCore --version 1.2.44
                    


                    

                
NuGet\Install-Package Scalar.AspNetCore -Version 1.2.44
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="1.2.44" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Scalar.AspNetCore" Version="1.2.44" />
                    


                            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 1.2.44
                    


                    

                
#r "nuget: Scalar.AspNetCore, 1.2.44"
#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. 
#:package Scalar.AspNetCore@1.2.44
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Scalar.AspNetCore&version=1.2.44
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Scalar.AspNetCore&version=1.2.44
                    


                            Install 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.

dotnet

Usage

  1. Install the package
dotnet add package Scalar.AspNetCore --version 1.2.*

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., 1.2.*.

  1. Add the using directive
using Scalar.AspNetCore;
  1. 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/v1 in your browser, where v1 is the default document name.

Configuration

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

Development

  1. Download .NET 9.0
  2. Jump to the package folder: cd packages/scalar.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/v1

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 (65)

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
RG3.PF.Utilities

1、【RG3.PF.Utilities】(可配置化，标准化，灵活配置，集成百度、腾讯、阿里、短信通等巨头接口，可脱离开发环境，集成nodejs中间件、统一认证中心) 2、以Rg3.开头且类继承 IService 或 IRepository的在Starup里面不用注入，案例如下 3、public class ListRepository : IRepository 4、public class ListService : IService 5、使用请到github获取 RG3.PF.WebApp.Host 6、6.0.0.77开始，nodeserice迁移到RG3.PF.PinYinScriptEngineCliWrap 7、被 RG3.WF.DSL 引用 8、 20240815 升级到.netcore sdk 8.0
ShayganTadbir.Framework.Core

Package description

GitHub repositories (47)

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

Repository Stars
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
JustArchiNET/ArchiSteamFarm
C# application with primary purpose of farming Steam cards from multiple accounts simultaneously.
dodyg/practical-aspnetcore
Practical samples of ASP.NET Core 10 RC 1, 9, 8.0, 7.0, 6.0, 5.0, 3.1, 2.2, and 2.1,projects you can use. Readme contains explanations on all projects.
dotnet/eShop
A reference .NET application implementing an eCommerce site
davidfowl/TodoApp
Todo application with ASP.NET Core Blazor WASM, Minimal APIs and Authentication
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.
ErsatzTV/ErsatzTV
Stream custom live channels using your own media
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
SteveDunn/Vogen
A semi-opinionated library which is a source generator and a code analyser. It Source generates Value Objects
meysamhadeli/booking-microservices
A practical microservices with the latest technologies and architectures like Vertical Slice Architecture, Event Sourcing, CQRS, DDD, gRpc, MongoDB, RabbitMq, Masstransit, and Aspire in .Net 9.
mehdihadeli/food-delivery-microservices
🍔 A practical and cloud-native food delivery microservices, built with .Net Aspire, .Net 9, MassTransit, Domain-Driven Design, CQRS, Vertical Slice Architecture, Event-Driven Architecture, and the latest technologies.
TheAxelander/OpenBudgeteer
OpenBudgeteer is a budgeting app based on the Bucket Budgeting Principle
json-api-dotnet/JsonApiDotNetCore
A framework for building JSON:API compliant REST APIs using ASP.NET and Entity Framework Core.
flyingpie/windows-terminal-quake
Enable Quake-style dropdown for (almost) any application.
erwinkramer/bank-api
The Bank API is a design reference project suitable to bootstrap development for a compliant and modern API.
lkurzyniec/netcore-boilerplate
Boilerplate of API in .NET 9
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
A practical Modular Monolith architecture with the latest technologies and architecture like Vertical Slice Architecture, Event Driven Architecture, CQRS, DDD, gRpc, Masstransit, and Aspire in .Net 9.
Version Downloads Last Updated
2.8.4 16,163 9/15/2025
2.8.3 14,644 9/13/2025
2.8.2 1,977 9/12/2025
2.8.1 18,976 9/10/2025
2.8.0 13,191 9/9/2025
2.7.4 10,186 9/9/2025
2.7.3 3,478 9/8/2025
2.7.2 135,177 8/25/2025
2.7.1 4,330 8/25/2025
2.7.0 22,019 8/22/2025
2.6.9 148,044 8/11/2025
2.6.8 99,177 8/3/2025
2.6.7 6,108 8/2/2025
2.6.6 3,653 8/1/2025
2.6.5 30,082 7/29/2025
2.6.4 114,720 7/21/2025
2.6.3 42,473 7/16/2025
2.6.2 3,652 7/16/2025
2.6.1 50,405 7/13/2025
2.6.0 20,319 7/10/2025
2.5.6 43,126 7/7/2025
2.5.5 5,417 7/7/2025
2.5.3 118,155 6/26/2025
2.5.1 17,770 6/25/2025
2.5.0 50,244 6/21/2025
2.4.22 27,091 6/19/2025
2.4.21 3,236 6/19/2025
2.4.20 9,362 6/19/2025
2.4.19 31,083 6/17/2025
2.4.18 4,178 6/17/2025
2.4.17 17,308 6/16/2025
2.4.16 24,953 6/14/2025
2.4.15 7,464 6/13/2025
2.4.14 5,734 6/13/2025
2.4.13 90,512 6/6/2025
2.4.12 3,477 6/6/2025
2.4.11 14,205 6/5/2025
2.4.9 4,077 6/5/2025
2.4.8 87,625 6/3/2025
2.4.7 44,017 5/30/2025
2.4.6 8,528 5/30/2025
2.4.5 12,822 5/29/2025
2.4.4 675,843 5/27/2025
2.4.3 42,713 5/23/2025
2.4.2 30,347 5/22/2025
2.4.1 17,983 5/22/2025
2.3.1 112,394 5/15/2025
2.3.0 69,469 5/12/2025
2.2.7 162,541 5/5/2025
2.2.5 50,272 5/1/2025
2.2.4 5,213 5/1/2025
2.2.3 7,164 4/30/2025
2.2.2 24,963 4/29/2025
2.2.1 113,610 4/24/2025
2.2.0 10,353 4/23/2025
2.1.18 31,539 4/22/2025
2.1.17 59,461 4/18/2025
2.1.16 27,532 4/16/2025
2.1.15 6,247 4/16/2025
2.1.14 3,004 4/16/2025
2.1.13 407,511 4/11/2025
2.1.12 4,020 4/11/2025
2.1.11 26,120 4/10/2025
2.1.10 8,147 4/10/2025
2.1.9 29,150 4/9/2025
2.1.8 21,867 4/8/2025
2.1.7 25,127 4/7/2025
2.1.6 33,917 4/4/2025
2.1.5 29,612 4/2/2025
2.1.4 58,660 3/31/2025
2.1.3 34,737 3/28/2025
2.1.2 36,058 3/26/2025
2.1.1 184,793 3/20/2025
2.1.0 55,970 3/19/2025
2.0.36 108,220 3/15/2025
2.0.34 8,860 3/14/2025
2.0.33 7,066 3/14/2025
2.0.30 60,323 3/12/2025
2.0.29 36,739 3/10/2025
2.0.28 3,617 3/10/2025
2.0.27 24,716 3/10/2025
2.0.26 51,564 3/7/2025
2.0.25 12,412 3/6/2025
2.0.24 16,619 3/6/2025
2.0.23 108,179 3/4/2025
2.0.22 19,416 3/3/2025
2.0.21 26,502 3/2/2025
2.0.20 18,557 2/28/2025
2.0.19 4,383 2/28/2025
2.0.18 215,771 2/21/2025
2.0.17 4,666 2/20/2025
2.0.16 13,240 2/20/2025
2.0.15 39,405 2/18/2025
2.0.14 65,464 2/13/2025
2.0.12 105,366 2/6/2025
2.0.11 49,456 2/4/2025
2.0.10 7,451 2/4/2025
2.0.9 76,147 1/30/2025
2.0.8 2,929 1/30/2025
2.0.7 29,335 1/28/2025
2.0.6 2,992 1/28/2025
2.0.5 16,236 1/27/2025
2.0.4 57,305 1/22/2025
2.0.2 45,989 1/20/2025
2.0.1 38,391 1/17/2025
2.0.0 7,604 1/16/2025
1.2.76 133,666 1/13/2025
1.2.75 17,325 1/11/2025
1.2.74 53,169 1/8/2025
1.2.73 8,581 1/7/2025
1.2.72 78,958 12/24/2024
1.2.71 6,820 12/23/2024
1.2.70 8,791 12/22/2024
1.2.69 2,411 12/22/2024
1.2.68 4,123 12/21/2024
1.2.67 1,570 12/20/2024
1.2.66 10,134 12/20/2024
1.2.65 1,762 12/19/2024
1.2.64 23,810 12/18/2024
1.2.63 9,037 12/18/2024
1.2.61 4,762 12/17/2024
1.2.60 5,372 12/17/2024
1.2.59 1,332 12/17/2024
1.2.58 1,248 12/16/2024
1.2.57 2,194 12/16/2024
1.2.56 22,012 12/15/2024
1.2.55 7,751 12/13/2024
1.2.54 1,884 12/13/2024
1.2.53 14,933 12/11/2024
1.2.52 1,814 12/11/2024
1.2.51 19,066 12/10/2024
1.2.50 10,945 12/9/2024
1.2.49 23,983 12/6/2024
1.2.48 8,113 12/5/2024
1.2.47 9,104 12/4/2024
1.2.46 2,298 12/4/2024
1.2.45 93,508 11/27/2024
1.2.44 43,205 11/23/2024
1.2.43 2,405 11/22/2024
1.2.42 46,663 11/21/2024
1.2.41 65,278 11/20/2024
1.2.40 1,788 11/19/2024
1.2.39 19,494 11/17/2024
1.2.38 981 11/16/2024
1.2.37 15,807 11/14/2024
1.2.36 29,551 11/13/2024
1.2.35 3,043 11/12/2024
1.2.34 29,767 11/10/2024
1.2.33 4,180 11/8/2024
1.2.32 972 11/7/2024
1.2.31 8,131 11/6/2024
1.2.30 2,786 11/4/2024
1.2.29 9,163 11/1/2024
1.2.28 1,626 11/1/2024
1.2.27 15,955 10/30/2024
1.2.26 8,428 10/30/2024
1.2.25 5,289 10/29/2024
1.2.24 2,093 10/28/2024
1.2.23 7,017 10/27/2024
1.2.22 8,827 10/24/2024
1.2.21 4,282 10/23/2024
1.2.20 1,255 10/22/2024
1.2.19 760 10/22/2024
1.2.18 7,129 10/20/2024
1.2.17 1,138 10/20/2024
1.2.16 1,486 10/19/2024
1.2.15 1,175 10/19/2024
1.2.14 799 10/18/2024
1.2.13 794 10/18/2024
1.2.12 2,050 10/18/2024
1.2.11 818 10/17/2024
1.2.10 6,174 10/17/2024
1.2.9 33,942 10/7/2024
1.2.8 1,117 10/7/2024
1.2.7 2,350 10/3/2024
1.2.6 834 10/2/2024
1.2.5 2,625 9/28/2024
1.2.4 5,356 9/22/2024
1.2.3 8,616 9/6/2024
1.1.2 15,607 7/18/2024
1.1.1 10,290 5/21/2024
1.0.1 816 5/15/2024