Sign In Start Free Trial
Account

Add to playlist

Create a Playlist

Modal Close icon
You need to login to use this feature.
  • Book Overview & Buying Hands-On .NET Web API Documentation with Swagger/OpenAPI
  • Table Of Contents Toc
Hands-On .NET Web API Documentation with Swagger/OpenAPI

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

By : Praveenkumar Bouna
close
close
Hands-On .NET Web API Documentation with Swagger/OpenAPI

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

By: Praveenkumar Bouna

Overview of this book

ASP.NET Web API is one of the hot topics in the ASP.NET world and many companies use APIs to connect front-end and back-end functionality at a large scale. What is the key element in such integrations? You need to document your web APIs so that they can be understood easily by developers. In this course, you will be learning about web API documentation using Swagger/OpenAPI concepts from scratch in this course. You will understand OpenAPI/Swagger and the need for documentation in web API. Learn the various approaches available for documenting a web API, including XML comments, data annotations, and so on. Also, we will use Swagger and Swagger UI tools from the OpenAPI community to create a rich API document. Then, create an OpenAPI document using Swashbuckle and NSwag in ASP.NET Web API. Learn how to use web API analyzers to guide you in including appropriate attributes for achieving complete documentation and web API conventions to automate and quickly document APIs with minimal effort. Next, understand the steps involved in documenting an API with multiple versions by creating one document per-version. By the end of this course, you will know how to document a web API project in ASP.NET Core using Swagger/OpenAPI from scratch. All the resources for this course are available at https://github.com/PacktPublishing/Hands-on-.NET-Web-API-Documentation-with-Swagger-OpenAPI
Table of Contents (8 chapters)
close
close
You're currently viewing a free sample. Access the full title and Packt library for free now with a free trial.
Chapter: 8
Documenting API Versions
Icon This video is locked
Icon
Icon
0:00
2.0x
1.5x
1.25x
1.0x
0.5x
caption settings
caption off
Icon Icon
ShowHide Transcripts Icon
CONTINUE WATCHING
83
Tech Concepts
36
Programming languages
73
Tech Tools
Icon Unlimited access to the largest independent learning library in tech of over 8,000 expert-authored tech books and videos.
Icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Icon 50+ new titles added per month and exclusive early access to books as they are being written.
Hands-On .NET Web API Documentation with Swagger/OpenAPI
notes
bookmark Notes and Bookmarks search Search in title playlist Add to playlist download Download options font-size Font size

Change the font size

margin-width Margin width

Change margin width

day-mode Day/Sepia/Night Modes

Change background colour

Close icon Search
Country selected

Close icon Your notes and bookmarks

Confirmation

Modal Close icon
claim successful

Buy this book with your credits?

Modal Close icon
Are you sure you want to buy this book with one of your credits?
Close
YES, BUY

Submit Your Feedback

Modal Close icon
Modal Close icon
Modal Close icon