Documenting an ASP.NET Core 2 API with OpenAPI / Swagger

Focused View

Kevin Dockx

2:50:55

60 View

01.Course Overview

0101.Course Overview.mp4

01:18

02.Getting Started with OpenAPI Swagger

0201.Coming Up.mp4

01:15

0202.Course Prerequisites.mp4

00:33

0203.Frameworks and Tooling.mp4

01:13

0204.Why Use Swagger OpenAPI to Document Your API.mp4

03:12

0205.Clearing up the Terminology Confusion.mp4

02:47

0206.Demo - Introducing the Demo Application.mp4

03:05

0207.Summary.mp4

01:05

03.Documenting Your First API with OpenAPI Swagger

0301.Coming Up.mp4

00:38

0302.Demo - Installing Swashbuckle.mp4

03:59

0303.Demo - Inspecting the Generated OpenAPI Specification.mp4

04:12

0304.Demo - Adding Swagger UI.mp4

03:48

0305.Demo - Incorporating XML Comments on Actions.mp4

04:26

0306.Demo - Incorporating XML Comments on Model Classes.mp4

01:23

0307.Demo - Improving Documentation with Data Annotations.mp4

02:26

0308.Demo - Improving Documentation with Examples.mp4

03:12

0309.Demo - Ignoring Warnings Where Appropriate.mp4

03:42

0310.Demo - Adding API Information and Description.mp4

02:53

0311.Summary.mp4

01:35

04.Using and Overriding Conventions for OpenAPI Generation

0401.Coming Up.mp4

01:16

0402.The Importance of ApiExplorer.mp4

01:35

0403.Why Its Important to Produce Correct Response Types.mp4

01:06

0404.Demo - Describing Response Types (Status Codes) with ProducesReponseType .mp4

06:32

0405.Demo - Using API Analyzers to Improve the OpenAPI Specification.mp4

08:55

0406.Demo - Working with API Conventions.mp4

04:35

0407.Demo - Creating Custom Conventions.mp4

05:52

0408.Attributes Versus Conventions.mp4

01:50

0409.Content Negotiation.mp4

01:53

0410.Demo - Specifying the Response Body Type with the Produces Attribute.mp4

06:02

0411.Demo - Specifying the Request Body Type with the Consumes Attribute.mp4

01:33

0412.Summary.mp4

01:25

05.Generating OpenAPI Specifications for Advanced Input and Output Scenarios

0501.Coming Up.mp4

00:55

0502.Content Negotiation with Vendor-specific Media Types.mp4

01:39

0503.Demo - Supporting Vendor-specific Media Types .mp4

04:55

0504.OpenAPI Support for Schema Variation by Media Type (Output).mp4

01:23

0505.Demo - Supporting Schema Variation by Media Type (Output, ResolveConflictingActions).mp4

05:27

0506.Demo - Supporting Schema Variation by Media Type (Output, IOperationFilter).mp4

06:31

0507.OpenAPI Support for Schema Variation by Media Type (Input).mp4

01:44

0508.Demo - Supporting Schema Variation by Media Type (Input).mp4

04:11

0509.Advanced Scenarios.mp4

00:52

0510.Summary.mp4

01:26

06.Dealing with Different Versions and Protecting the Documentation

0601.Coming Up.mp4

00:38

0602.Working with Multiple OpenAPI Specifications.mp4

00:58

0603.Demo - Working with Multiple OpenAPI Specifications.mp4

03:31

0604.Versioning with ASP.NET Cores Built-in Approach.mp4

01:50

0605.Demo - Versioning Your API.mp4

07:19

0606.Demo - Matching OpenAPI Specifications to API Versions.mp4

07:54

0607.Protecting Your API.mp4

02:59

0608.Demo - Protecting Your API.mp4

03:40

0609.Demo - Adding Authentication Support to the OpenAPI Specification.mp4

04:07

0610.Summary.mp4

01:29

07.Improving Your Documentation with Advanced Customization

0701.Coming Up.mp4

00:45

0702.Enriching Comments with Markdown.mp4

00:33

0703.Demo - Enriching Comments with Markdown.mp4

03:23

0704.Demo - Basic UI Customization with the Configuration API.mp4

02:07

0705.Supporting Deep Linking.mp4

00:49

0706.Demo - Supporting Deep Linking.mp4

00:59

0707.Branding the UI.mp4

02:19

0708.Demo - Branding the UI by Injecting Custom CSS.mp4

02:57

0709.Demo - Branding the UI by Injecting a Custom Index Page.mp4

03:11

0710.Summary.mp4

01:08

Description

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.

More details

User Reviews

Rating

average 0

Total votes0

Focused display

ASP.NET Core

REST API

API Testing

API

Kevin Dockx

Instructor's Courses

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 projects, like Microsoft.AspNet.JsonPatch & Marvin.Cache.Headers. Kevin likes to travel to places he hasn't seen before, and enjoys a good glass of wine in the company of a few good friends.

Pluralsight

View courses Pluralsight

Pluralsight, LLC is an American privately held online education company that offers a variety of video training courses for software developers, IT administrators, and creative professionals through its website. Founded in 2004 by Aaron Skonnard, Keith Brown, Fritz Onion, and Bill Williams, the company has its headquarters in Farmington, Utah. As of July 2018, it uses more than 1,400 subject-matter experts as authors, and offers more than 7,000 courses in its catalog. Since first moving its courses online in 2007, the company has expanded, developing a full enterprise platform, and adding skills assessment modules.