Skip to main content

.NET 9–OpenAPI and Scalar–Introduction

With the release of .NET 9, Microsoft has removed Swashbuckle from the default Web API templates. If you have never heard about Swashbuckle before, it allowed you to generate OpenAPI metadata for your web api's. Although I had no complaints using the Swagger UI, I decided to use the opportunity to have a look at library, Scalar, to generate an UI based on the OpenAPI documentation.

In this post, I’ll walk you through my transition from Swashbuckle to Scalar, highlighting the benefits, challenges, and key implementation steps.

Why the change?

Microsoft decided to drop Swashbuckle due to maintenance issues and a shift toward integrated OpenAPI support. While Swashbuckle provided automatic documentation, Swagger UI integration, and customizability, Scalar introduces a sleek UI, mobile-friendly interface, and enhanced search capabilities. Scalar not only provides great integration for .NET but also works on a lot of other platforms.

Setting Up Scalar in .NET 9

To integrate Scalar into your .NET 9 Web API, follow these steps:

  • Start by installing the required packages

dotnet add package Scalar.AspNetCore

dotnet add package Microsoft.AspNetCore.OpenApi

  • Next step is to configure the OpenAPI integration in our Program.cs file.
  • The configuration above will generate a default v1.json OpenAPI metadata file that is accessible at /openapi/v1.json.

  • The last step is to access the API documentation through Scalar. You can access the Scalar UI by browsing to /scalar/v1, which provides an interactive API documentation experience.
    • Remark: the v1 part should match with the name of the OpenApi document that is used in the OpenApi configuration.

In a next post I look at how we can further tweak the experience when using the built-in OpenAPI support and Scalar. Stay tuned!

More information

Scalar - Document, Test & Discover APIs

Announcement: Swashbuckle.AspNetCore is being removed in .NET 9 · Issue #54599 · dotnet/aspnetcore

Labels:

Popular posts from this blog

Kubernetes–Limit your environmental impact

Reducing the carbon footprint and CO2 emission of our (cloud) workloads, is a responsibility of all of us. If you are running a Kubernetes cluster, have a look at Kube-Green . kube-green is a simple Kubernetes operator that automatically shuts down (some of) your pods when you don't need them. A single pod produces about 11 Kg CO2eq per year( here the calculation). Reason enough to give it a try! Installing kube-green in your cluster The easiest way to install the operator in your cluster is through kubectl. We first need to install a cert-manager: kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.5/cert-manager.yaml Remark: Wait a minute before you continue as it can take some time before the cert-manager is up & running inside your cluster. Now we can install the kube-green operator: kubectl apply -f https://github.com/kube-green/kube-green/releases/latest/download/kube-green.yaml Now in the namespace where we want t...
Read more

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.
Read more

DevToys–A swiss army knife for developers

As a developer there are a lot of small tasks you need to do as part of your coding, debugging and testing activities.  DevToys is an offline windows app that tries to help you with these tasks. Instead of using different websites you get a fully offline experience offering help for a large list of tasks. Many tools are available. Here is the current list: Converters JSON <> YAML Timestamp Number Base Cron Parser Encoders / Decoders HTML URL Base64 Text & Image GZip JWT Decoder Formatters JSON SQL XML Generators Hash (MD5, SHA1, SHA256, SHA512) UUID 1 and 4 Lorem Ipsum Checksum Text Escape / Unescape Inspector & Case Converter Regex Tester Text Comparer XML Validator Markdown Preview Graphic Col...
Read more