Hi, thanks for creating this package. Our API is spec'd out using multiple OpenAPI files (Redoc seems to recommend this approach as well). I didn't see a way to configure that in the config, as it doesn't accept folder, but requires pointing to a OpenAPI spec file directly.

Thanks for your help, would love to be able to use your package!

Problem - Redoc route is public and unprotected

Solution - Optional middleware in route configuration, user can specify which middleware the route is covered by, fallback to empty array if middleware config is missing for backwards compatibility with older configs.

For some reason the hostname setting only shows the hostname when set to false (boolean), but hides the hostname when set to "false" (string) as the comments suggest to use. All other config variables work with stringified booleans, which is very confusing. I just wanted to bring this up as an issue, instead of assuming how you want this fixed.

I'm happy to open a PR to bring the config values more inline with what a Laravel develop might expect, if that is something that would help you out. (For example, all the config values are inverted in their meaning, as in hostname should actually be hideHostname and be a true boolean, then handle it accordingly in the blade view to meet the redoc requirements. Just a suggestion.)

Thanks! :)

Problem

With the latest version of redoc 2x alpha it appears that whenever the attribute disable-search is added to the redoc tag, regardless of the value it is set to, search is disabled.

Solution

To fix this, we can conditionally render the disable-search attribute only for when it is needed.

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

Hi

First off, great package and easy to use, we prefer to have our documentation sit behind authentication, however the current set up does not allow for middleware.

I have created a pull request #6 to allow for middleware, it does have backwards compatibility with configs that may not have the path.middleware key.