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 1m
- Demo - Installing Swashbuckle 4m
- Demo - Inspecting the Generated OpenAPI Specification 4m
- Demo - Adding Swagger UI 4m
- Demo - Incorporating XML Comments on Actions 4m
- Demo - Incorporating XML Comments on Model Classes 1m
- Demo - Improving Documentation with Data Annotations 2m
- Demo - Improving Documentation with Examples 3m
- Demo - Ignoring Warnings Where Appropriate 4m
- Demo - Adding API Information and Description 3m
- Summary 2m
- Coming Up 1m
- The Importance of ApiExplorer 2m
- Why It's Important to Produce Correct Response Types 1m
- Demo - Describing Response Types (Status Codes) with ProducesReponseType 7m
- Demo - Using API Analyzers to Improve the OpenAPI Specification 9m
- Demo - Working with API Conventions 5m
- Demo - Creating Custom Conventions 6m
- Attributes Versus Conventions 2m
- Content Negotiation 2m
- Demo - Specifying the Response Body Type with the Produces Attribute 6m
- Demo - Specifying the Request Body Type with the Consumes Attribute 2m
- Summary 1m
- Coming Up 1m
- Content Negotiation with Vendor-specific Media Types 2m
- Demo - Supporting Vendor-specific Media Types 5m
- OpenAPI Support for Schema Variation by Media Type (Output) 1m
- Demo - Supporting Schema Variation by Media Type (Output, ResolveConflictingActions) 5m
- Demo - Supporting Schema Variation by Media Type (Output, IOperationFilter) 7m
- OpenAPI Support for Schema Variation by Media Type (Input) 2m
- Demo - Supporting Schema Variation by Media Type (Input) 4m
- Advanced Scenarios 1m
- Summary 1m
- Coming Up 1m
- Working with Multiple OpenAPI Specifications 1m
- Demo - Working with Multiple OpenAPI Specifications 4m
- Versioning with ASP.NET Core’s Built-in Approach 2m
- Demo - Versioning Your API 7m
- Demo - Matching OpenAPI Specifications to API Versions 8m
- Protecting Your API 3m
- Demo - Protecting Your API 4m
- Demo - Adding Authentication Support to the OpenAPI Specification 4m
- Summary 1m
- Coming Up 1m
- Enriching Comments with Markdown 1m
- Demo - Enriching Comments with Markdown 3m
- Demo - Basic UI Customization with the Configuration API 2m
- Supporting Deep Linking 1m
- Demo - Supporting Deep Linking 1m
- Branding the UI 2m
- Demo - Branding the UI by Injecting Custom CSS 3m
- Demo - Branding the UI by Injecting a Custom Index Page 3m
- Summary 1m