1. import requests
  2. import json
  4. def index_api_endpoints(api_base_url, default_values):
  5. """
  6. Indexes API endpoints for diagnostics, checking their status and returning
  7. a list of dictionaries with endpoint details and status.
  8. """
  9. endpoints = []
  11. # Define a list of potential diagnostic endpoints. Expand as needed.
  12. endpoints_list = [
  13. "/health",
  14. "/version",
  15. "/metrics",
  16. "/status"
  17. ]
  19. for endpoint in endpoints_list:
  20. url = f"{api_base_url}{endpoint}"
  21. try:
  22. response = requests.get(url, timeout=5) # Add timeout for robustness
  23. response.raise_for_status() # Raise HTTPError for bad responses (4xx or 5xx)
  25. # Attempt to parse the response as JSON
  26. try:
  27. data = response.json()
  28. except json.JSONDecodeError:
  29. data = response.text # If JSON parsing fails, use text
  31. endpoint_data = {
  32. "url": url,
  33. "status_code": response.status_code,
  34. "response_time": response.elapsed.total_seconds(),
  35. "response_data": data # Store the raw response data
  36. }
  37. endpoints.append(endpoint_data)
  39. except requests.exceptions.RequestException as e:
  40. # Handle connection errors, timeouts, etc.
  41. endpoint_data = {
  42. "url": url,
  43. "status_code": None,
  44. "response_time": None,
  45. "error": str(e) # Store the error message
  46. }
  47. endpoints.append(endpoint_data)
  49. return endpoints
  52. if __name__ == '__main__':
  53. # Example usage:
  54. api_base = "http://localhost:8000" # Replace with your API base URL
  55. default_values = {"timeout": 5} # Example default values (not used in this version)
  57. diagnostics = index_api_endpoints(api_base, default_values)
  59. for endpoint in diagnostics:
  60. print(json.dumps(endpoint, indent=4))

Add your comment