-
Course
- Core Tech
Documenting an ASP.NET Core 2 API with OpenAPI / Swagger
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 you'll learn how to do that.
What you'll learn
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.
Table of contents
- Coming Up | 38s
- Demo - Installing Swashbuckle | 3m 59s
- Demo - Inspecting the Generated OpenAPI Specification | 4m 12s
- Demo - Adding Swagger UI | 3m 48s
- Demo - Incorporating XML Comments on Actions | 4m 26s
- Demo - Incorporating XML Comments on Model Classes | 1m 23s
- Demo - Improving Documentation with Data Annotations | 2m 26s
- Demo - Improving Documentation with Examples | 3m 12s
- Demo - Ignoring Warnings Where Appropriate | 3m 42s
- Demo - Adding API Information and Description | 2m 53s
- Summary | 1m 35s
- Coming Up | 1m 16s
- The Importance of ApiExplorer | 1m 35s
- Why It's Important to Produce Correct Response Types | 1m 6s
- Demo - Describing Response Types (Status Codes) with ProducesReponseType | 6m 32s
- Demo - Using API Analyzers to Improve the OpenAPI Specification | 8m 55s
- Demo - Working with API Conventions | 4m 35s
- Demo - Creating Custom Conventions | 5m 52s
- Attributes Versus Conventions | 1m 50s
- Content Negotiation | 1m 53s
- Demo - Specifying the Response Body Type with the Produces Attribute | 6m 2s
- Demo - Specifying the Request Body Type with the Consumes Attribute | 1m 33s
- Summary | 1m 25s
- Coming Up | 55s
- Content Negotiation with Vendor-specific Media Types | 1m 39s
- Demo - Supporting Vendor-specific Media Types | 4m 55s
- OpenAPI Support for Schema Variation by Media Type (Output) | 1m 23s
- Demo - Supporting Schema Variation by Media Type (Output, ResolveConflictingActions) | 5m 27s
- Demo - Supporting Schema Variation by Media Type (Output, IOperationFilter) | 6m 31s
- OpenAPI Support for Schema Variation by Media Type (Input) | 1m 44s
- Demo - Supporting Schema Variation by Media Type (Input) | 4m 11s
- Advanced Scenarios | 52s
- Summary | 1m 26s
- Coming Up | 38s
- Working with Multiple OpenAPI Specifications | 58s
- Demo - Working with Multiple OpenAPI Specifications | 3m 31s
- Versioning with ASP.NET Core’s Built-in Approach | 1m 50s
- Demo - Versioning Your API | 7m 19s
- Demo - Matching OpenAPI Specifications to API Versions | 7m 54s
- Protecting Your API | 2m 59s
- Demo - Protecting Your API | 3m 40s
- Demo - Adding Authentication Support to the OpenAPI Specification | 4m 7s
- Summary | 1m 29s
- Coming Up | 45s
- Enriching Comments with Markdown | 33s
- Demo - Enriching Comments with Markdown | 3m 23s
- Demo - Basic UI Customization with the Configuration API | 2m 7s
- Supporting Deep Linking | 49s
- Demo - Supporting Deep Linking | 59s
- Branding the UI | 2m 19s
- Demo - Branding the UI by Injecting Custom CSS | 2m 57s
- Demo - Branding the UI by Injecting a Custom Index Page | 3m 11s
- Summary | 1m 8s
About the author
Kevin Dockx is a freelance solution architect (mobile/web), author & consultant, living in Antwerp (Belgium).
More Courses by Kevin