According to OpenAPI 3.0 it isn’t possible. But what if you really want it to be? Do you have to just settle and allow your Swagger documentation to be wrong? I’m here to show you how to make optional route parameters with Swagger and ASP.NET Core.

Swagger is a great way of dynamically documenting web APIs. However, I have seen a great share of broken Swagger set ups, such as the entire documentation failing to generate due to an invalid attribute annotation, or a public controller method which has not been bootstrapped to an HTTP method.

This post is going to use one of the tools provided by NSwag to generate C# client classes to provide access to an API. While the NSwag tooling provides multiple ways to discover the definition of an API we will be using the tooling to generate C# classes from an OpenAPI/Swagger specification.

Swagger tooling for API's built with ASP.NET Core. Generate beautiful API documentation, including a UI to explore and test operations, directly from your routes, controllers and models.

The minimum configuration of Swagger is nice to get started but let’s add some more customization.

pproval testing is a method of testing that not many are familiar with. If I were to hypothesise why this is, I'd say it's because of it narrow application, especially when contrasted to other more common forms of forms of testing.

Swagger needs no introduction. It is one of the best methods to test your WEB APIs. Adding swagger to your ASP.NET Core application is very easy and straightforward. I already have a couple of posts on my blog on Swagger. Swagger comes with many options and customization to help you prepare better API documentation.

Following these simple 4 steps to add document generation capability for your API. Using the Swashbuckle NuGet package to add document generation ability to our ASP.Net Core project.