Скачать или смотреть How to Describe API Roles and Permissions in OpenAPI (Without OAuth2) | Redocly Tutorial

In this video, we guide you through setting up API roles and permissions in OpenAPI without using OAuth2 flows. Learn how to define permissions, customize role terminology, link a detailed permissions page, and set up linting rules for consistent API access control. This tutorial is perfect for API developers looking to manage access controls in OpenAPI and customize how permissions are displayed in Redocly.

By the end of this video, you’ll know how to:

1. Describe API roles and permissions directly in OpenAPI.
2. Link to a custom permissions page for in-depth documentation.
3. Customize labels to replace terms like ‘Required scopes’ with ‘Required permissions.’
4. Create linting rules to enforce predefined role names in OpenAPI.
• Stay tuned for more Redocly tutorials and tips on managing and customizing API documentation!

Timestamps
00:00 Intro
00:23 OpenAPI Spec Roles
00:40 Example Security Requirement
00:52 Creating a Permissions Info Page
01:15 Linking the Permissions Page in the Security Scheme
01:45 Customizing Display Text for Roles
02:09 Adding Linting Rules for Permissions Consistency
02:50 Testing the Developer Experience
03:12 Testing the End-User Experience
03:31 Conclusion