1. /**
  2. * Formats API responses for validation checks with error logging.
  3. * @param {object} response The API response object.
  4. * @param {function} validate The validation function. Takes the response as input and returns true if valid, false otherwise.
  5. * @param {string} endpoint The API endpoint being checked (for logging).
  6. */
  7. function formatApiResponseAndValidate(response, validate, endpoint) {
  8. try {
  9. // Log the endpoint being checked
  10. console.log(`Validating response from endpoint: ${endpoint}`);
  12. // Format the response for readability
  13. const formattedResponse = formatResponse(response);
  15. // Validate the response
  16. const isValid = validate(formattedResponse);
  18. if (isValid) {
  19. console.log(`Validation successful for endpoint: ${endpoint}`);
  20. return formattedResponse; // Return the formatted response if valid
  21. } else {
  22. console.error(`Validation failed for endpoint: ${endpoint}`);
  23. console.error("Detailed Response:", formattedResponse); // Log the formatted response for debugging
  24. return null; // Or throw an error, depending on your error handling strategy
  25. }
  26. } catch (error) {
  27. console.error(`Error processing response from endpoint: ${endpoint}`, error);
  28. return null; // Or throw the error, depending on your error handling strategy
  29. }
  30. }
  34. /**
  35. * Formats the API response for better readability in logs/validation.
  36. * @param {object} response The raw API response.
  37. * @returns {string} The formatted response as a JSON string.
  38. */
  39. function formatResponse(response) {
  40. try {
  41. return JSON.stringify(response, null, 2); // Pretty-print JSON with indentation
  42. } catch (error) {
  43. console.error("Error formatting response:", error);
  44. return String(response); // Return the raw response if formatting fails
  45. }
  46. }
  48. // Example usage (can be removed if not needed)
  49. // const sampleResponse = {
  50. // "status": "success",
  51. // "data": {
  52. // "id": 123,
  53. // "name": "Example Item",
  54. // "value": 42
  55. // }
  56. // };
  58. // function validateResponse(response) {
  59. // // Example validation: check if 'status' is 'success' and 'data' has 'name'
  60. // return response.status === "success" && response.data && response.data.name;
  61. // }
  63. // formatApiResponseAndValidate(sampleResponse, validateResponse, "/api/items");

Add your comment