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

Podman– Command execution failed with exit code 125

After updating WSL on one of the developer machines, Podman failed to work. When we took a look through Podman Desktop, we noticed that Podman had stopped running and returned the following error message: Error: Command execution failed with exit code 125 Here are the steps we tried to fix the issue: We started by running podman info to get some extra details on what could be wrong: >podman info OS: windows/amd64 provider: wsl version: 5.3.1 Cannot connect to Podman. Please verify your connection to the Linux system using `podman system connection list`, or try `podman machine init` and `podman machine start` to manage a new Linux VM Error: unable to connect to Podman socket: failed to connect: dial tcp 127.0.0.1:2655: connectex: No connection could be made because the target machine actively refused it. That makes sense as the podman VM was not running. Let’s check the VM: >podman machine list NAME         ...
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

VS Code Planning mode

After the introduction of Plan mode in Visual Studio , it now also found its way into VS Code. Planning mode, or as I like to call it 'Hannibal mode', extends GitHub Copilot's Agent Mode capabilities to handle larger, multi-step coding tasks with a structured approach. Instead of jumping straight into code generation, Planning mode creates a detailed execution plan. If you want more details, have a look at my previous post . Putting plan mode into action VS Code takes a different approach compared to Visual Studio when using plan mode. Instead of a configuration setting that you can activate but have limited control over, planning is available as a separate chat mode/agent: I like this approach better than how Visual Studio does it as you have explicit control when plan mode is activated. Instead of immediately diving into execution, the plan agent creates a plan and asks some follow up questions: You can further edit the plan by clicking on ‘Open in Editor’: ...
Read more