Problems accessing the API v2 docs

Development
1

I’ve looked in the Mautic forum for information on fixing a problem with my Mautic instance. My v2 API documentation isn’t showing right. I couldn’t find anything there on how to solve the issue.

When I go to https://myinstance/api/v2, I get the following:

image
image428×247 2.26 KB

I’m not sure if there’s an occ command to fix this? I watched a video on YouTube that indicated that the API documentation is supposed to appear there in accordian style presentation, but instead the interface appears to be broken.

Where would I post this problem/find a solution to this problem or even find out about how this OpenAPI documentation route is supposed to work internally (dev_docs)?

2

In the browser developer console, I am getting 404 errors for the fixed assets. I don’t know where the physical files are located to check the file permissions

3

Hey there!

Following from Slack (thanks for posting here!) I would check the browser console - it looks like your CSS and whatnot are not being loaded. See if there’s any errors there, which might help track down what’s going on. Also try things like a hard refresh on the browser etc just to check it’s not something wonky there.

1 Like
4

On my instance, they’re located in /bundles/apiplatform:

image
image290×667 23.6 KB

5

image
image1729×804 86.4 KB

6

The weird thing is that I don’t have a bundles folder in the root at all?

image
image821×874 137 KB

7

I do have the following folder vendor/api-platform/core/src/Symfony/Bundle/Resources/public/

image
image674×322 47.9 KB

8

I found this, and am looking into if there is something helpful in this GitHub issue - Add OpenAPI support to Mautic API · Issue #8780 · mautic/mautic · GitHub

9

I also found this - Swagger/OpenAPI support for Mautic API - #8 by ash_s85 but that doesn’t seem to be very helpful either.

10

I found this PR on the issue here API Platform implementation by nileshlohar · Pull Request #14812 · mautic/mautic · GitHub and looking into if there is anything helpful when Mautic installs and doesn’t properly set up the resource publishing.

11

I guess the issue might be happening if you’re not installing with Composer - is that the case for you?

See this comment in particular:

12

Hello,

I had this as well at first, despite composer.

Try:

bin/console asset:install

That failed and I first had to change the docroot folder:

Give it a try and see whether that helps.
Which version are you currently using? 7.0.1?

13

Well, that did install the assets, however they are visible under public/bundles/.. instead of bundles/.. which still causes the page to display without loading the assets.

Do we also need to have mod_rewrite for public to / in the .htaccess?

15

We are using OpenLightSpeed server. In order to tell OLS to serve up the /public/bundles/…/…/ as /bundles/…/…/ I had to complete the following:

OLS, here is the exact, minimal configuration you need for that Static Context to work:

  1. The Core Settings

In Virtual Hosts > [Your VHost] > Context > Add (Static):

  • URI: /bundles/
  • Location: /full/path/to/your/site/public/bundles/ (Ensure this is the absolute path starting from /).
  • Accessible: Yes
  1. The Rewrite Settings (On the same screen)

Scroll down to the Rewrite section of this specific context:

  • Enable Rewrite: Yes
  • Rewrite Rules:
RewriteEngine On
  1. The “Secret Sauce” (Graceful Restart)

This is where most OLS configurations fail. After you click Save:

  1. Look at the very top of the WebAdmin console.
  2. You will see a red/orange icon or a message saying “Configuration has been modified. To apply changes, please perform a graceful restart.”
  3. Click the Graceful Restart icon (the circle-arrow). If you don’t do this, the 404 will persist.
16

If you’re using OpenLightSpeed (and other admin panels) it’s getting more complex.

This question might become an OLS question now.
I recommend the command line way. It’s not fancy, but at least you’d know how you setup your server and make it match Mautic.

In the standard composer setup, the correct root folder for your vhost is:

docroot

Anything else (OLS specific) might not work properly or needs to be adjusted “the ols way”.

17

I don’t have a docroot folder in my hierarchy. This install of Mautic has been upgraded one version at a time all the way from version 3. I have been using this instance for many years.

I did a test to see if I could make the DocumentRoot /public, but that didn’t work. The way I documented above was the only way I could get the API documentation screen to work properly after I completed the `bin/console asset:install` command you recommended.

18

If I should be backing up certain files, directories, and the Mautic 7 database, reinstalling and restoring those files, I would need help knowing what to do, but for now, this was my work around that both; allows the main Mautic 7 instance to load properly, and allows the API ui to load the assets it’s supposed to.