Question 1

How do I add code samples to my Redoc documentation?

Accepted Answer

Use the x-codeSamples vendor extension in your OpenAPI specification to define code samples for each operation. Redoc will automatically render them in the documentation panel, as shown in the features demo with animated GIFs.

Question 2

Redoc vs Swagger UI: which is better for API docs?

Accepted Answer

Redoc offers a more polished, responsive UI with better navigation synchronization, but Swagger UI includes an interactive try-it console. Choose Redoc for presentation-focused, static documentation, and Swagger UI if you need built-in API testing capabilities.

Question 3

Can I customize the colors and theme in Redoc?

Accepted Answer

Yes, Redoc provides configuration options for theming, but extensive visual changes often require using specification extensions or custom CSS, which can be more complex than drop-in solutions. Refer to the configuration documentation for details.

Question 4

How to deploy Redoc on a static site like GitHub Pages?

Accepted Answer

Generate a static HTML file using the CLI with 'npx @redocly/cli build-docs', then upload the output to your static hosting. Alternatively, use the HTML element method with CDN links for quick embedding without local builds.

Question 5

Does Redoc support OpenAPI 3.1 fully?

Accepted Answer

Yes, Redoc fully supports OpenAPI 3.1 along with 3.0 and Swagger 2.0, as stated in the features. This ensures compatibility with the latest API standards and specifications.

Question 6

How to group tags in the Redoc side menu?

Accepted Answer

Use the x-tagGroups extension in your OpenAPI spec to categorize tags into logical groups. Redoc will display these groups in an organized menu structure, improving navigation for complex APIs.

ReDoc

What is ReDoc?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions