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

Cache stampede: when our cache turned against us

While investigating some performance issues, we ran into an ASP.NET Core API that cached a fairly expensive aggregation query for 60 seconds. Under normal load, that was fine: one request rebuilds the cache, everyone else reads from it. Under peak load, dozens of requests would arrive in that same expiry window, all see a cache miss, and all fire the same expensive query in parallel. The database didn't like that. That was the moment when our caching layer stopped helping and started hurting. A burst of requests comes in at the same time, all miss the cache, and all go hammer the database or the downstream API at once. That's a cache stampede . The cache was supposed to protect our backend, and for a few hundred milliseconds it did the opposite. Why this happens IMemoryCache.GetOrCreate (and its async sibling) looks like it protects you, but it doesn't add any locking on its own. Look at the naive version: public async Task<Report> GetReportAsync(string key) ...
Read more

A complex system designed from scratch never works

A few years ago, I worked as an architect on a big mainframe rewrite. I still count it as one of my failures. Not because the technology was wrong, but because I couldn't convince the management team to simplify the approach. Years later, the organization is still struggling to get the new system up and running. I left the project at the time, because I couldn't put my name behind an approach that would take very long and cost a lot of money without a working system to show for it along the way. Gall’s Law That memory keeps coming back to me, because it's a textbook case of Gall's Law playing out in real life. Gall's Law , from John Gall's Systemantics , states it plainly: A complex system that works is invariably found to have evolved from a simple system that worked. A complex system designed from scratch never works, and it cannot be patched to make it work. You have to start over with a simple system that works. What does that mean in practice,...
Read more