Failed to load API definition when when using portal.proxy.path

• Type: Bug
• Status: Closed
• Resolution: Fixed
• Affects Version/s: Master
• Fix Version/s: 7.4.3.38 CE GA38, 7.4.3.39 CE GA39, 7.4.3.40 CE GA40, Master
• Component/s: Headless Delivery API
• Labels:
  • 7.4-known-issues
  • backend_test
  • liferay-ga36-ce-743-known-issues
  • liferay-ga37-ce-743-known-issues
• Story Points: 5
• Fix Priority: 4
• Sprint: S05E07 - Axie Infinity
• Git Pull Request: https://github.com/brianchandotcom/liferay-portal/pull/121314

Steps:

1. Configure a reverse proxy (e.g. using Apache)

   <VirtualHost *:5001>
     ServerName localhost
     ProxyPreserveHost On
     <location /portal>
       ProxyPass "http://localhost:8080"
       ProxyPassReverse "http://localhost:8080"
     </location>
   </VirtualHost>
   

2. Prepare a clean bundle with the following portal property:

   portal.proxy.path=/portal
   web.server.http.port=5001
   

3. Start Liferay
4. Navigate to http://localhost:5001/portal
   • Login as admin user
5. Navigate to http://localhost:5001/portal/o/api/

Expected results
The page should load successfully.

Actual results
Failed to load API definition.

Note: Please refer to this article about how to set up Apache proxy.