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 6 Web API Using Swagger

via Pluralsight

Overview



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.

Syllabus

  • Course Overview 1min
  • Getting Started with OpenAPI (Swagger) 19mins
  • Documenting Your First API with OpenAPI (Swagger) 37mins
  • Customizing OpenAPI Generation with Attributes and Conventions 51mins
  • Generating OpenAPI Specifications for Advanced Input and Output Scenarios 37mins
  • Dealing with Different Versions and Protecting the Documentation 33mins
  • Improving Your Documentation with Advanced Customization 19mins

Taught by

Kevin Dockx

Reviews

4.9 rating at Pluralsight based on 85 ratings

Start your review of Documenting an ASP.NET Core 6 Web API Using Swagger

Never Stop Learning.

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

Someone learning on their laptop while sitting on the floor.