ASP.NET Core API Documentation with OpenAPI/Swagger:3.0 Documenting your API with OpenAPI/Swagger
Welcome to My Course ASP.Net Core API Documentation with OpenAPI / Swagger
If you are not familiar with course Please have a look at Course Overiew Video • ASP.NET Core API Documentation with OpenAP...
In this Video
We will add OpenAPI support to our API.
1 ) We'll start by adding Swashbuckle to our application both for API generation and for generating a documentation UI.
2) Then we'll improve the documentation by adding XML comments in the API Specification.
3) We'll also see how data annotations affect the generated specification and how we can provide sample requests or auto remarks.
4) We'll end the module by learning how to provide a general description in documentation for our API.
Let's start.
Video Chapter Index
0:00 Video Started
1) 0:11 Learned in Last Video
2) 0:56 Going To Learn in this Video
3) 1:29 Demo - Installing Swashbuckle
4) 5:33 Demo - Inspecting the Generated OpenAPI Specification
5) 10:01 Demo - Adding Swagger UI
6) 13:45 Demo - Incorporating XML Comments on Actions
7) 18:03 Demo - Incorporating XML Comments on Model Classes
8) 19:36 Demo - Improving Documentation with Data Annotations
9) 22:28 Demo - Improving Documentation with Examples
10) 25:28 Demo - Ignoring Warnings Where Appropriate
11) 29:15 Demo - Adding API Information and Description
12) 32:10 Summary
#CodeMechanic #dotnetcore #swagger #webapi #OpenAPI #dotnet