Documenting an ASP.NET Core API with OpenAPI / Swagger

Documenting an API is often regarded as a tedious yet essential task. By using OpenAPI / Swagger, which integrates nicely with ASP.NET Core, you can take on this task. In this course you'll learn how to do that.
Course info
Rating
(130)
Level
Intermediate
Updated
Feb 27, 2019
Duration
2h 50m
Table of contents
Course Overview
Getting Started with OpenAPI / Swagger
Documenting Your First API with OpenAPI / Swagger
Using and Overriding Conventions for OpenAPI Generation
Generating OpenAPI Specifications for Advanced Input and Output Scenarios
Dealing with Different Versions and Protecting the Documentation
Improving Your Documentation with Advanced Customization
Description
Course info
Rating
(130)
Level
Intermediate
Updated
Feb 27, 2019
Duration
2h 50m
Your 10-day individual free trial includes:

Expert-led courses

Keep up with the pace of change with thousands of expert-led, in-depth courses.
Description

Documenting an API is often regarded as a tedious yet essential task. By using OpenAPI / Swagger, which integrates nicely with ASP.NET Core, you can take on this task. In this course, Documenting an ASP.NET Core API with OpenAPI / Swagger, you will gain the ability to document your API. First, you will learn how to add documentation for your API and add a UI that allows testing the API. Next, you will discover how to use attributes and conventions to improve the generated OpenAPI specification. Finally, you will explore how to deal with authentication, versioning and UI customization. When you are finished with this course, you will have the skills and knowledge of OpenAPI needed to correctly document your ASP.NET Core API.

About the author
About the author

Kevin Dockx is a freelance solution architect (mobile/web), author & consultant, living in Antwerp (Belgium).

More from the author
Consuming an OData v4 API
Beginner
1h 12m
Jun 25, 2021
Using HttpClient to Consume APIs in .NET
Intermediate
3h 26m
Jun 1, 2021
More courses by Kevin Dockx
Section Introduction Transcripts
Section Introduction Transcripts

Course Overview
Hi everyone. My name is Kevin. Welcome to my course, Documenting an ASP.NET Core API with OpenAPI/Swagger. I'm a Microsoft MVP and freelance solution architect currently focused on APIs and security. In this course, we're going to learn how to document an ASP.NET Core API. Some of the major topics that we will cover include learning what OpenAPI or Swagger is all about and how it can help with documenting your API, using attributes or conventions to drive OpenAPI generation, dealing with authentication and versioning, and customizing your documentation UI. By the end of this course, you will have extensive knowledge on what OpenAPI or Swagger is and how to use it to document your API. Before beginning this course, you should be familiar with C# and with building an API with ASP.NET Core. I hope you'll join me on this journey to learn how to document your API with the Documenting an ASP.NET Core API with OpenAPI/Swagger course at Pluralsight.