Hands-on .NET Web API Documentation with Swagger/OpenAPI

Documenting ASP.NET Core Web API with Swashbuckle, NSwag, Swagger, and OpenAPI through a step-by-step approach.

Created by: Praveenkumar Bouna
Cloud Instructor

What Will I Learn?

• Understand OpenAPI/Swagger, their differences, and the need for documentation in Web API.
• Create an OpenAPI document using Swashbuckle in ASP .NET Web API through a step-by-step approach.
• Create an OpenAPI document using NSwag in ASP .NET Web API step-by-step.
• Use Swagger and Swagger UI tools from the OpenAPI community to create a rich API document.
• Use Web API Analyzers to guide you in including appropriate attributes for achieving complete documentation.
• Use Web API Conventions to automate and quickly document APIs with minimal efforts.
• Learn the various approaches available for documenting a Web API including XML comments, data annotations, and so on.
• Understand the steps involved in documenting API with multiple versions by creating one document per version.

Requirements

• Basic knowledge of building Web API in ASP .NET Core. If you want to learn how to build a Web API, check out my related course under my profile.
• Basic knowledge of OpenAPI/Swagger Specification. If you want to learn about OpenAPI, check out my related course under my profile.
• A PC running Windows, macOS, or Linux with Visual Studio Code (or similar IDE that can build C# projects) to carry out hands-on activities and exercises.

Target audience

• Backend Web Developers who build web services that are consumed by internal teams or external 3rd party teams.
• Software Architects who assist fellow developers to implement RESTful Web API in their projects.