git/goodpackagerepo
1
0
Fork 0
mirror of https://github.com/johndoe6345789/goodpackagerepo.git synced 2026-04-24 13:54:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation for API URL detection logic

Browse Source 
Co-authored-by: johndoe6345789 <224850594+johndoe6345789@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2026-01-08 19:05:01 +00:00
parent e79dc38cce
commit 09f894ac4a
1 changed files with 21 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
frontend/src/utils/api.js
View File

@@ -2,16 +2,26 @@
* Get the API base URL for making backend requests
*
* Priority:
* 1. NEXT_PUBLIC_API_URL environment variable (if set)
* 1. NEXT_PUBLIC_API_URL environment variable (if set) - RECOMMENDED for production
* 2. Try to infer from current location for common deployment patterns
* 3. Default to localhost:5000 for local development
*
* For production deployments, it's recommended to set NEXT_PUBLIC_API_URL.
* For production deployments, it's strongly recommended to set NEXT_PUBLIC_API_URL.
*
* Common deployment patterns:
* - Single domain with reverse proxy: NEXT_PUBLIC_API_URL=/api or same origin
* - Separate subdomains: NEXT_PUBLIC_API_URL=https://api.example.com
* - CapRover: NEXT_PUBLIC_API_URL=https://backend-app.your-domain.com
* - Single domain with reverse proxy: Set NEXT_PUBLIC_API_URL="" or "/api"
* (if backend is served under /api path)
* - Separate subdomains: Set NEXT_PUBLIC_API_URL=https://api.example.com
* - CapRover/separate apps: Set NEXT_PUBLIC_API_URL=https://backend-app.your-domain.com
* - Same host, different port: Will auto-detect if frontend is on non-standard port
*
* When NEXT_PUBLIC_API_URL is not set:
* - For localhost: defaults to http://localhost:5000 (standard backend dev port)
* - For deployed sites on custom port: tries backend on port 5000 (uncommon but supported)
* - For deployed sites on standard ports: assumes same-origin (works with reverse proxy)
*
* Note: The auto-detection logic assumes the backend is accessible without a path prefix.
* If your backend is served under /api or another path, you MUST set NEXT_PUBLIC_API_URL.
*
* @returns {string} The API base URL
*/
@@ -27,15 +37,16 @@ export function getApiUrl() {
// If running on a deployed domain (not localhost), try intelligent defaults
if (hostname !== 'localhost' && hostname !== '127.0.0.1') {
// Common pattern 1: Backend on same host, different port (e.g., backend on :5000)
// This works for simple deployments where both are on same server
// Pattern 1: Frontend on custom port (e.g., :3000) - try backend on :5000
// This handles the case where both are on the same host with different ports
// Note: This is uncommon in production but may occur in some deployments
if (port && port !== '80' && port !== '443') {
// Frontend is on custom port, try backend on 5000
return `${protocol}//${hostname}:5000`;
}
// Common pattern 2: Same origin (works with reverse proxy)
// Many deployments use nginx/traefik to route /api -> backend
// Pattern 2: Same origin (works with reverse proxy routing)
// This assumes backend is on the same host/port as frontend
// Common with nginx/traefik routing different paths to different services
return `${protocol}//${hostname}`;
}