Last updated

Redoc quickstart guide

To render your OpenAPI definition using Redoc, use the following HTML code sample and replace the spec-url attribute with the URL or local file address to your definition.

<!DOCTYPE html>
    <!-- needed for adaptive design -->
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />

    Redoc doesn't change outer page styles
      body {
        margin: 0;
        padding: 0;
    Redoc element with link to your OpenAPI definition
    <redoc spec-url=""></redoc>
    Link to Redoc JavaScript on CDN for rendering standalone element
    <script src=""></script>
Redoc requires an HTTP server to run locally

Loading local OpenAPI definitions is impossible without running a web server because of issues with same-origin policy and other security reasons. Refer to Running Redoc locally for more information.

For a more detailed explanation with step-by-step instructions and additional options for using Redoc, refer to the Redoc deployment guide.