Documenting an API is often regarded as a tedious yet essential task. By using OpenAPI / Swagger, which integrates nicely with ASP.NET Core, you can take on this task. In this course, Documenting an ASP.NET Core API with OpenAPI / Swagger, you will gain the ability to document your API. First, you will learn how to add documentation for your API and add a UI that allows testing the API. Next, you will discover how to use attributes and conventions to improve the generated OpenAPI specification. Finally, you will explore how to deal with authentication, versioning and UI customization. When you are finished with this course, you will have the skills and knowledge of OpenAPI needed to correctly document your ASP.NET Core API.
Author Name: Kevin Dockx
Author Description:
Kevin Dockx is a freelance solution architect, author & consultant, living in Antwerp (Belgium). He’s mainly focused on solution/application architectures & security for web-based (API) applications built with .NET, but he also keeps an eye out for new developments concerning other products from the .NET stack. He’s a Microsoft MVP and board member of the RD MS Community. He’s also a regular speaker at various (inter)national conferences & user group events, and works on various open source pro… more

Table of Contents

• Course Overview
  1min
• Getting Started with OpenAPI / Swagger
  13mins
• Documenting Your First API with OpenAPI / Swagger
  32mins
• Using and Overriding Conventions for OpenAPI Generation
  42mins
• Generating OpenAPI Specifications for Advanced Input and Output Scenarios
  29mins
• Dealing with Different Versions and Protecting the Documentation
  34mins
• Improving Your Documentation with Advanced Customization
  18mins