API integration debug prompt template

In modern software development, API (Application Programming Interface) integration is an indispensable part of connecting systems, exchanging data, and extending functionality. However, this is also the area most prone to errors due to its dependence on many external factors such as networking, authentication, data formats, or changes from third-party services.

 

Debugging APIs often becomes complicated when errors are not limited to client-side code but also involve server issues, environment configuration, or unexpected data returns. Problems such as timeouts, incorrect endpoints, authentication errors (401/403), or incorrect schema responses can severely disrupt the application.

Therefore, using API-integrated debugging prompts helps programmers approach problems more systematically and efficiently. Instead of manual and undirected debugging, these prompts support detailed analysis of request/response, headers, validation, logging, and runtime behavior. As a result, the debugging process becomes faster, more accurate, and more reusable in various situations.

This article will provide a practical prompt template to help you quickly identify the cause of errors and suggest solutions when working with APIs in different environments such as REST, GraphQL, or microservices.

API integration debug prompt template

Prompt will help troubleshoot API issues.

Gỡ lỗi vấn đề tích hợp API này: API: [TÊN API/ENDPOINT] Lỗi: [THÔNG BÁO LỖI HOẶC HÀNH VI] Yêu cầu: [DÁN CODE YÊU CẦU] Phản hồi: [DÁN PHẢN HỒI] Tài liệu: [URL TÀI LIỆU API] Hãy giúp tôi: 1. Xác định vấn đề 2. Sửa định dạng yêu cầu 3. Xử lý các trường hợp ngoại lệ 4. Thêm xử lý lỗi phù hợp

 

Best suited for: GPT-5, Gemini 2.5 Pro

How to use sample prompts

Replace the following information in order:

• API: JSONPlaceholder
• Errors: Server errors (HTTP 4xx, 5xx), No response received (network/timeout), Request configuration errors, Custom code errors.
• Request:

// apiDebugDemo.js const axios = require("axios"); // Tạo instance axios với config cơ bản const apiClient = axios.create({ baseURL: "https://jsonplaceholder.typicode.com", timeout: 5000, }); // Interceptor: Log request trước khi gửi apiClient.interceptors.request.use( (config) => { console.log("=== API REQUEST ==="); console.log("URL:", config.baseURL + config.url); console.log("Method:", config.method.toUpperCase()); console.log("Headers:", config.headers); console.log("Params:", config.params); console.log("Data:", config.data); console.log("====================n"); return config; }, (error) => { console.error("Request Error:", error.message); return Promise.reject(error); } ); // Interceptor: Log response khi nhận được apiClient.interceptors.response.use( (response) => { console.log("=== API RESPONSE ==="); console.log("Status:", response.status); console.log("Data:", response.data); console.log("====================n"); return response; }, (error) => { console.error("=== API ERROR ==="); if (error.response) { // Server trả về response lỗi (4xx, 5xx) console.error("Status:", error.response.status); console.error("Data:", error.response.data); } else if (error.request) { // Request gửi đi nhưng không nhận được response console.error("No response received"); } else { // Lỗi khi setup request console.error("Error:", error.message); } console.error("====================n"); return Promise.reject(error); } ); // Hàm gọi API async function fetchPosts() { try { const response = await apiClient.get("/posts", { params: { userId: 1 } }); return response.data; } catch (error) { console.error("Fetch failed!"); } } // Chạy thử fetchPosts();

 

• Response: Response in the code =
  • response.status → 200 (success)
  • response.data → list of articles from API
• Documentation: https://jsonplaceholder.typicode.com

The example prompt results were generated using GPT-5.

Gỡ lỗi vấn đề tích hợp API này: API: JSONPlaceholder Lỗi: Lỗi từ server (HTTP 4xx, 5xx), Không nhận được response (network/timeout), Lỗi cấu hình request, Lỗi custom trong code Yêu cầu: // apiDebugDemo.js const axios = require("axios"); // Tạo instance axios với config cơ bản const apiClient = axios.create({ baseURL: "https://jsonplaceholder.typicode.com", timeout: 5000, }); // Interceptor: Log request trước khi gửi apiClient.interceptors.request.use( (config) => { console.log("=== API REQUEST ==="); console.log("URL:", config.baseURL + config.url); console.log("Method:", config.method.toUpperCase()); console.log("Headers:", config.headers); console.log("Params:", config.params); console.log("Data:", config.data); console.log("====================n"); return config; }, (error) => { console.error("Request Error:", error.message); return Promise.reject(error); } ); // Interceptor: Log response khi nhận được apiClient.interceptors.response.use( (response) => { console.log("=== API RESPONSE ==="); console.log("Status:", response.status); console.log("Data:", response.data); console.log("====================n"); return response; }, (error) => { console.error("=== API ERROR ==="); if (error.response) { // Server trả về response lỗi (4xx, 5xx) console.error("Status:", error.response.status); console.error("Data:", error.response.data); } else if (error.request) { // Request gửi đi nhưng không nhận được response console.error("No response received"); } else { // Lỗi khi setup request console.error("Error:", error.message); } console.error("====================n"); return Promise.reject(error); } ); // Hàm gọi API async function fetchPosts() { try { const response = await apiClient.get("/posts", { params: { userId: 1 } }); return response.data; } catch (error) { console.error("Fetch failed!"); } } // Chạy thử fetchPosts(); Phản hồi: Phản hồi trong đoạn code = response.status → 200 (thành công) response.data → danh sách bài viết từ API Tài liệu: https://jsonplaceholder.typicode.com Hãy giúp tôi: 1. Xác định vấn đề 2. Sửa định dạng yêu cầu 3. Xử lý các trường hợp ngoại lệ 4. Thêm xử lý lỗi phù hợp