Building well-documented versioned HTTP APIs in ASP.NET Core
Anybody that has built HTTP or REST APIs, has had to deal with things like OpenAPI or Swagger. Those are reasonably trivial to implement using ASP.NET Core, and you even get a nice Swagger UI website out of the box.
Just like any interface or programmatic contract, there are plenty of aspects that need careful analysis. Think of comprehensive online documentation for your APIs, using HTTP error codes appropriately, and providing clarity on what fields in the JSON are required and which are optional or can be empty. And don't forget versioning. Allowing a developer to view and switch between the supported versions and make it clear what APIs are deprecated isn't as trivial as you may think.
In this talk, I'll show you everything that you might need to know about building nicely documented, properly versioned HTTP APIs that make your consumers happy.
About the speaker
Dennis Doomen
Dennis is a Microsoft MVP and Principal Consultant at Dutch Microsoft consultancy firm Aviva Solutions. With 29 years of experience under his belt as a software architect and/or lead developer, he specializes in designing full-stack enterprise solutions based on .NET as well as providing coaching on all aspects of designing, building, documenting, deploying and maintaining software systems in an agile world. He is the author of several open-source projects, including Fluent Assertions, Pathy, Reflectify, PackageGuard, and several .NET Solution Templates, and has been maintaining coding guidelines for C# since 2001. You can find him on Twitter, Mastodon and BlueSky.
