Scalar.Net 1.0.3

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Scalar.Net --version 1.0.3
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Scalar.Net" />
                    


                            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.Net --version 1.0.3
                    


                    

                
#r "nuget: Scalar.Net, 1.0.3"
#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.Net@1.0.3
#: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.Net&version=1.0.3
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Scalar.Net&version=1.0.3
                    


                            Install as a Cake Tool

Scalar.Net

GitHub Repo stars

This project is a simple middleware that will expose Scalar documentation for your .NET API on the route which you want for your Swagger/OpenApi specs.

Installation

You can install this easily from Nuget on the following location:

NuGet

Usage

After installation you'll need to alter your startup and add Scalar to the services. You can to this by calling next method:

//map configuration to scalar options
builder.Services.AddScalar(opts => builder.Configuration.GetSection("Scalar").Bind(opts));

//or manually set them
builder.Services.AddScalar(opts => 
{
    opts.Theme = ScalarLayoutType.Modern;
});

Available configuration options are located here. And they closely mimic the configuration on the related node packages over on original Scalar repository. You can find original configuration on this link.

After configuring options be sure to also include Scalar middlware in your pipeline in order to show the documentation. You can do this by simply calling next method:

//map scalar endpoint wherever you want
app.Map("/docs", a =>
{
    a.UseScalar();
});

And that is it. Simply visit the related endpoint and you should see your spec generate the related documentation and run the Scalar app in browser.

Examples

Examples directory contains a sample project which has swagger and scalar integrated so you can more closely follow how to set this up. Few images of this can be found below:

Documentation page: Scalar documentation

Documentation request editor: Scalar documentation

License

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 was computed.  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.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.3 680 4/25/2024
1.0.1 163 4/24/2024