Scalar.AspNetCore
2.0.2
See the version list below for details.
dotnet add package Scalar.AspNetCore --version 2.0.2
NuGet\Install-Package Scalar.AspNetCore -Version 2.0.2
<PackageReference Include="Scalar.AspNetCore" Version="2.0.2" />
paket add Scalar.AspNetCore --version 2.0.2
#r "nuget: Scalar.AspNetCore, 2.0.2"
// Install Scalar.AspNetCore as a Cake Addin #addin nuget:?package=Scalar.AspNetCore&version=2.0.2 // Install Scalar.AspNetCore as a Cake Tool #tool nuget:?package=Scalar.AspNetCore&version=2.0.2
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
- 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.*
.
- Add the using directive
using Scalar.AspNetCore;
- 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
- Download .NET 9.0
- Jump to the package folder:
cd packages/scalar.aspnetcore
- Do a fresh build:
dotnet build
- Run the tests:
dotnet test
And see it in action here:
- Switch to the playground:
cd playground/Scalar.AspNetCore.Playground
- Start the playground:
dotnet run
- 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:
- Run Docker Compose:
docker compose up --build
- 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 | Versions 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. |
-
net8.0
- No dependencies.
-
net9.0
- No dependencies.
NuGet packages (28)
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 |
|
ShayganTadbir.Framework.Core
Package description |
|
Milochau.Core.Aws.Integration
Milochau.Core.Aws.Integration contains integration tests helpers as part of the Milochau.Core.Aws framework for applications. |
|
Corner49.Infra
An opinionated set of infrastructure libraries for .Net applications |
GitHub repositories (27)
Showing the top 5 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
|
|
grandnode/grandnode2
Open-Source eCommerce Platform on .NET Core, MongoDB, AWS DocumentDB, Azure CosmosDB, LiteDB & Vue.js
|
|
GZTimeWalker/GZCTF
The GZ::CTF project, an open source CTF platform.
|
Version | Downloads | Last updated |
---|---|---|
2.0.12 | 4,882 | 5 days ago |
2.0.11 | 4,852 | 6 days ago |
2.0.10 | 714 | 7 days ago |
2.0.9 | 13,666 | 11 days ago |
2.0.8 | 535 | 12 days ago |
2.0.7 | 6,230 | 13 days ago |
2.0.6 | 477 | 14 days ago |
2.0.5 | 3,426 | 14 days ago |
2.0.4 | 12,446 | 19 days ago |
2.0.2 | 9,008 | 22 days ago |
2.0.1 | 12,263 | 25 days ago |
2.0.0 | 2,438 | a month ago |
1.2.76 | 22,368 | a month ago |
1.2.75 | 6,333 | a month ago |
1.2.74 | 15,863 | a month ago |
1.2.73 | 3,258 | a month ago |
1.2.72 | 32,753 | 2 months ago |
1.2.71 | 3,100 | 2 months ago |
1.2.70 | 4,945 | 2 months ago |
1.2.69 | 1,133 | 2 months ago |
1.2.68 | 1,588 | 2 months ago |
1.2.67 | 498 | 2 months ago |
1.2.66 | 3,388 | 2 months ago |
1.2.65 | 422 | 2 months ago |
1.2.64 | 7,532 | 2 months ago |
1.2.63 | 4,099 | 2 months ago |
1.2.61 | 2,741 | 2 months ago |
1.2.60 | 1,645 | 2 months ago |
1.2.59 | 298 | 2 months ago |
1.2.58 | 173 | 2 months ago |
1.2.57 | 979 | 2 months ago |
1.2.56 | 8,190 | 2 months ago |
1.2.55 | 4,234 | 2 months ago |
1.2.54 | 226 | 2 months ago |
1.2.53 | 8,544 | 2 months ago |
1.2.52 | 837 | 2 months ago |
1.2.51 | 9,878 | 2 months ago |
1.2.50 | 4,585 | 2 months ago |
1.2.49 | 10,869 | 2 months ago |
1.2.48 | 4,385 | 2 months ago |
1.2.47 | 5,497 | 2 months ago |
1.2.46 | 847 | 2 months ago |
1.2.45 | 67,415 | 2 months ago |
1.2.44 | 21,905 | 3 months ago |
1.2.43 | 1,117 | 3 months ago |
1.2.42 | 10,997 | 3 months ago |
1.2.41 | 15,183 | 3 months ago |
1.2.40 | 719 | 3 months ago |
1.2.39 | 12,327 | 3 months ago |
1.2.38 | 281 | 3 months ago |
1.2.37 | 8,670 | 3 months ago |
1.2.36 | 13,038 | 3 months ago |
1.2.35 | 2,204 | 3 months ago |
1.2.34 | 11,814 | 3 months ago |
1.2.33 | 2,412 | 3 months ago |
1.2.32 | 294 | 3 months ago |
1.2.31 | 3,814 | 3 months ago |
1.2.30 | 2,087 | 3 months ago |
1.2.29 | 4,795 | 3 months ago |
1.2.28 | 983 | 3 months ago |
1.2.27 | 6,072 | 3 months ago |
1.2.26 | 2,802 | 3 months ago |
1.2.25 | 2,459 | 3 months ago |
1.2.24 | 1,248 | 3 months ago |
1.2.23 | 4,834 | 3 months ago |
1.2.22 | 3,292 | 4 months ago |
1.2.21 | 3,222 | 4 months ago |
1.2.20 | 631 | 4 months ago |
1.2.19 | 117 | 4 months ago |
1.2.18 | 4,984 | 4 months ago |
1.2.17 | 435 | 4 months ago |
1.2.16 | 660 | 4 months ago |
1.2.15 | 528 | 4 months ago |
1.2.14 | 227 | 4 months ago |
1.2.13 | 208 | 4 months ago |
1.2.12 | 883 | 4 months ago |
1.2.11 | 229 | 4 months ago |
1.2.10 | 3,246 | 4 months ago |
1.2.9 | 14,479 | 4 months ago |
1.2.8 | 511 | 4 months ago |
1.2.7 | 678 | 4 months ago |
1.2.6 | 240 | 4 months ago |
1.2.5 | 1,417 | 4 months ago |
1.2.4 | 3,263 | 5 months ago |
1.2.3 | 6,203 | 5 months ago |
1.1.2 | 11,098 | 7 months ago |
1.1.1 | 4,968 | 9 months ago |
1.0.1 | 598 | 9 months ago |