Skip to main content

Detecting breaking changes in your OpenAPI metadata

For the last 2 days I have been struggling with a breaking change I had in my ASP.NET Core web api that caused the consuming application to fail. I had a header parameter that was optional but became required after changing the nullability of my project to enabled.

Although I found the issue and was able to fix it quite fast, I was not happy with my current process and was wondering how I could prevent this from happening again.

This brought me to a final solution where I introduced some extra tests that compared the OpenAPI metadata between different implementations. Let me show you how I did it…

Generate OpenAPI documents at build time

To compare 2 OpenAPI metadata documents we first need to get them. For the already released version of the API, I can download the document through the OpenAPI endpoint (/openapi/v1.json by default). But what about the new version of the API that is still in development?

I solve this by generating the OpenAPI document at build time. This makes it easy to use and compare the OpenAPI documents without the need of hosting our OpenAPI.

Enabling build time generation is easy. We only need to add the following NuGet package to our project:

dotnet add package Microsoft.Extensions.ApiDescription.Server

Now if we build our application, it will:

  • Automatically generate the Open API document(s) associated with the app during build.
  • Populate the Open API documents in the app's output directory as {ProjectName}.json.

You can further customize this if you want. For more info on how to do this, have a look at the documentation:

Compare OpenAPI documents

Now that we have 2 OpenAPI documents available, we can compare them. Therefore I use the Open API Comparator. This tool is available both as a command line tool and as a nuget package.

To install it run the following command:

dotnet add package Criteo.OpenApi.Comparator

We can now integrate this in a unit test as you can see below:

If API changes are found, you can see the details on what has changed:

More information

Generate OpenAPI documents | Microsoft Learn

criteo/openapi-comparator

Popular posts from this blog

.NET 8–Keyed/Named Services

A feature that a lot of IoC container libraries support but that was missing in the default DI container provided by Microsoft is the support for Keyed or Named Services. This feature allows you to register the same type multiple times using different names, allowing you to resolve a specific instance based on the circumstances. Although there is some controversy if supporting this feature is a good idea or not, it certainly can be handy. To support this feature a new interface IKeyedServiceProvider got introduced in .NET 8 providing 2 new methods on our ServiceProvider instance: object? GetKeyedService(Type serviceType, object? serviceKey); object GetRequiredKeyedService(Type serviceType, object? serviceKey); To use it, we need to register our service using one of the new extension methods: Resolving the service can be done either through the FromKeyedServices attribute: or by injecting the IKeyedServiceProvider interface and calling the GetRequiredKeyedServic...

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.

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