Simple play icon Course

Documenting an ASP.NET Core Web API Using Swagger

by Kevin Dockx

Documenting an API is essential. By using Swagger (OpenAPI), which integrates nicely with ASP.NET Core, you can take on this task. In this course you'll learn how to do that.

What you'll learn

Documenting an API is often regarded as a tedious, yet essential, task. In this course, Documenting an ASP.NET Core Web API using Swagger, you'll use Swagger (OpenAPI), which integrates nicely with ASP.NET Core, to take on this task. First, you'll discover how to add documentation for your API and add a UI that allows testing the API. Next, you'll see that built-in conventions already go a long way towards generating an OpenAPI specification for your API, but you can override them when needed. Finally, you'll learn how to customize the UI of the generated documentation, and what other use cases there are for OpenAPI - like generating automated tests for your API and generating client-side code from the specification. When you're finished with this course you'll know the ins and outs of OpenAPI and how it can help with documenting your API and more.

Table of contents

Course Overview

About the author

Kevin Dockx is a freelance solution architect, author & consultant, living in Antwerp (Belgium). He's mainly focused on solution/application architectures & security for web-based (API) applications built with .NET, but he also keeps an eye out for new developments concerning other products from the .NET stack. He's a Microsoft MVP and board member of the RD MS Community. He's also a regular speaker at various (inter)national conferences & user group events, and works on various open source pro... more

Ready to upskill? Get started