Fetch API Documentation

When to Use

• Before implementing a new feature that calls an API endpoint, fetch its docs to confirm the available parameters, request body schema, and response format.
• When a Jira ticket references API dependencies (e.g., "Requires API-11: GET /api/categories"), fetch those endpoints to understand the contract.
• When adding query parameters to an ApiClient call, verify the parameter names and types match the API spec.
• When debugging unexpected API responses, compare the actual response against the documented schema.

Procedure

1. Identify which API endpoints the current task depends on.
2. Run the script with those endpoint paths to retrieve full documentation.
3. Use the output to inform service method signatures, controller parameters, and TypeScript types.

Output Format

For each endpoint, the script outputs:

• Method and path (e.g., GET /api/products)
• Summary and description
• Parameters with name, location (query/path), required/optional, type, enum values, and defaults
• Request body schema and content type
• Response schemas per status code with examples

API URL Resolution

The script reads API_URL from the project's .env file. Falls back to http://192.168.0.193:8000 if not found.