UI Questions

[mikebronner]

Hi @JustSteveKing, we have successfully implemented our OpenAPI spec file now, and I have a few questions that I'm not sure how to address, if you don't mind?

1. Is there a way to customize the theme, say add a logo, customize colors, etc?
2. The search functionality doesn't seem to be working, as the search field doesn't show even if I change the config setting.
3. Long examples don't seem to wrap nicely, and get obscured behind the right sidebar. This may be addressable by editing the theme, per question # 1.
4. is automatic doc generation something that might be on the roadmap? Not required, just curios.

I really like you package, as it lets me create my docs using the spotlight.io GUI, and push them to my repo, and your package automatically renders it. Sweetness right there. :)

Thanks again for you time.

PS: Here's our work in progress: https://mike-b.totalitylms.com/api/docs

Updates

For things I have found answers to in the meantime, noting these here as these might help others out.

• you can add a logo by adding the following to your spec file:

  {
  // ..
  "info": {
    "x-logo": {
        "url": "<url to image>",
        "altText": "<your logo alt text>"
    },
    // ...
  },
  // ...
  }

• I realize now that things like theming and rendering, as well as automatic document generation are way out of scope of this package.
• to get search to work, you must add the following to your content security policies:

  child-src: blob:;

• to customize the theme:
  • publish this packages views: php artisan vendor:publish --provider="JustSteveKing\Laravel\LaravelRedoc\RedocServiceProvider"
  • customize the doc.blade.php view. It is important to note that the theme attribute must be in single-quotes, so that the json it contains uses double-quotes, otherwise it won't render.

    <redoc
     theme='{"colors": {"primary": { "main": "#FF5733"}}}'
     <!-- ... -->
    ></redoc>

  • see the following link for theming options: https://redoc.ly/docs/api-reference-docs/configuration/theming/#example-theme

[mikebronner]

Hi @JustSteveKing -- it looks like I answered all my own questions after researching things this afternoon. Feel free to use what I found to update the documentation -- I think it might benefit people like me, who come from Laravel without knowing how ReDoc works. :)