Autoplay
Autocomplete
Previous Lesson
Complete and Continue
Hands-on .NET Web API Documentation with Swagger/OpenAPI
Course Introduction
Welcome & About This Course (5:09)
Recommended: Development Environment
Getting Started with OpenAPI
Introduction (1:29)
Overview of OpenAPI (4:57)
Swagger vs OpenAPI (4:15)
Design-first vs Code-first (6:19)
OpenAPI Implementations for .NET (3:40)
Why Document APIs? (3:03)
How to Document APIs? (3:10)
Overview of Demo Project (7:07)
Creating OpenAPI using Swashbuckle
Introduction (1:37)
Overview of Swashbuckle (4:07)
Step 1: Install Swashbuckle (3:21)
Step 2: Configure Swashbuckle (1:27)
A Note about ApiExplorer (2:29)
Overview of Generated OpenAPI Spec (3:53)
Step 3: Add SwaggerUI (2:48)
Summary (2:19)
Adding Documentation using Swashbuckle
Introduction (1:35)
Step 4: Add OpenAPI Metadata (6:26)
Step 5: Enable Documentation using XML Comments (4:27)
Step 6: Add Documentation using XML Comments (7:07)
Step 7: Add Data Annotations (5:59)
Handling Compiler Warnings (3:22)
Summary (2:21)
Section 5: Creating OpenAPI using NSwag
Introduction (1:23)
Install NSwag (2:14)
Add SwaggerUI (3:28)
Configure NSwag (8:31)
Summary (1:51)
Using Web API Analyzers
Introduction (1:45)
What are Web API Analyzers? (3:11)
Step 8: Enable Web API Analyzers (2:09)
Step 9: Add Annotations as per Warnings (5:48)
Summary (1:39)
Using Web API Conventions
Introduction (1:45)
What are Web API Conventions? (5:40)
Step 10: Applying Web API Conventions (10:08)
Step 11: Update Action Names as per Conventions (9:53)
Step 12: Create Custom API Conventions (7:56)
Attributes vs Conventions: Which One to Use? (1:48)
Summary (1:49)
Documenting API Versions
Introduction (2:20)
Step 13: Enable API Versioning (5:31)
Need for Handling Version During Documentation (2:10)
Step 14: Add Support for Multiple Versions (5:37)
Step 15: Add Document for Each Version (4:11)
Using Generic Version Handler (9:28)
Summary (1:14)
Course Conclusion
Congratulations!
Attributes vs Conventions: Which One to Use?
Lesson content locked
If you're already enrolled,
you'll need to login
.
Enroll in Course to Unlock