Class Central is learner-supported. When you buy through links on our site, we may earn an affiliate commission.

Pluralsight

Documenting an ASP.NET Core API with OpenAPI / Swagger

via Pluralsight

Overview

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.

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.

Topics:
  • 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

Taught by

Kevin Dockx

Related Courses

Reviews

Start your review of Documenting an ASP.NET Core API with OpenAPI / Swagger

Never Stop Learning!

Get personalized course recommendations, track subjects and courses with reminders, and more.

Sign up for free