When you enroll through our links, we may earn a small commission—at no extra cost to you. This helps keep our platform free and inspires us to add more value.
Documenting an ASP.NET Core Web API Using Swagger
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.
This Course Includes
pluralsight
5 (76 reviews )
3 hour 19 minutes 
english
Online - Self Paced
core courses
pluralsight
About Documenting an ASP.NET Core Web API Using Swagger
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.
What You Will Learn?
- 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.