Скачать или смотреть How to Fix the Authentication Section Not Showing Issue in Redoc

Discover why the authentication section is missing in Redoc and learn how to fix it by adding the ` SecurityDefinitions / ` tag.
---
This video is based on the question https://stackoverflow.com/q/72690501/ asked by the user 'Cephalopod' ( https://stackoverflow.com/u/340556/ ) and on the answer https://stackoverflow.com/a/72858041/ provided by the user 'nalmada' ( https://stackoverflow.com/u/4420144/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: redoc not showing authentication section

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Fixing the Missing Authentication Section in Redoc

If you're working with OpenAPI specifications, you may have encountered a frustrating issue: the authentication section doesn't display properly when using Redoc on a standalone HTML page. While you may be able to see this section when previewing through the OpenApi Editor plugin, it can be disheartening to find it absent in your HTML file. In this guide, we will delve into why this happens and how to resolve it effectively.

Understanding the Problem

The absence of the authentication section often occurs due to changes in how security definitions are handled in OpenAPI specifications. When using the current structure of OpenAPI (specifically version 3.0.3 as in your example), security definitions may shift under the operational context—resulting in them being tightly integrated with the endpoints and not globally defined as they once were. This may lead to the following:

Missing Global Security Definitions: Redoc relies on certain tags to understand how to display authentication sections. If these tags are absent, you'll notice gaps in the rendered documentation.

Variations in Rendering: Rendering in local editors like IntelliJ could be managed differently than standalone HTML files, causing discrepancies in how sections appear.

Solution: Adding Security Definitions

To restore the missing authentication section in your standalone HTML implementation of Redoc, you need to utilize the <SecurityDefinitions /> tag in the appropriate section of your OpenAPI YAML file. Follow these organized steps to implement this solution:

Step 1: Update Your OpenAPI YAML File

Open your openapi.yml file in your preferred text editor (like IntelliJ).

Add the following tag to your global description field or wherever you want the security definitions section to appear:

[[See Video to Reveal this Text or Code Snippet]]

In the context of your current YAML structure, it might look like this:

[[See Video to Reveal this Text or Code Snippet]]

Step 2: Verify Your HTML Page

Ensure that your HTML includes the necessary Redoc configuration:

[[See Video to Reveal this Text or Code Snippet]]

Step 3: Test Your Implementation

Save both the updated OpenAPI YAML and the HTML file.

Open your HTML file in a web browser.

Check the displayed documentation to see if the authentication section appears as expected.

Conclusion

By adding the <SecurityDefinitions /> tag to your OpenAPI YAML file, you can effectively resolve the issue of the missing authentication section when using Redoc. Now, your documentation will be complete and will offer users the necessary authentication details clearly and accessibly. If you encounter further issues, reviewing your OpenAPI structure and ensuring all configurations are correct might help troubleshoot the problem. Happy documenting!