February 2022
Advanced
3h 19m
English
Closed Captioning available in English
Overview
In this 3-hour course, you will learn how to document ASP.NET Core Web APIs using Swagger/OpenAPI through tools like Swashbuckle and NSwag. This course takes a hands-on, step-by-step approach, covering everything from creating and styling OpenAPI documents to handling multiple API versions.
What I will be able to do after this course
- Understand the fundamentals of OpenAPI/Swagger and the importance of API documentation.
- Document APIs using tools and approaches such as XML comments, Swashbuckle, and NSwag.
- Learn to use Web API analyzers and conventions to streamline the documentation process.
- Effectively document multi-version APIs and consolidate versioned documentation.
- Gain practical experience with Swagger and Swagger UI to create interactive and user-friendly documentation.
Course Instructor(s)
Praveenkumar Bouna is a seasoned software developer with extensive experience in ASP.NET and web API projects. With a passion for teaching, he specializes in breaking down complex technical concepts into simple, actionable steps for learners. His practical approach ensures that learners are equipped with skills they can directly apply to their projects.
Who is it for?
This course is perfect for backend web developers familiar with ASP.NET Core and OpenAPI who want to create well-documented APIs for both internal use and third-party integration. It also benefits software architects aiming to guide teams in implementing RESTful web APIs with comprehensive documentation.
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Watch now
Unlock full access
More than 5,000 organizations count on O’Reilly
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.Julian F.
I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.Addison B.
I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.Amir M.
I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.