符合台灣

API 文件說明撰寫指令｜讓串接方不用一直來問你怎麼用

王王梓恩・行銷／社群編輯 ·被複製 440 次·最後更新 2026/06/27

適用模型ChatGPTClaude

一句話結論輸入 API endpoint 資訊、參數說明與範例，AI 幫你產出清楚的 API 說明文件，讓前端、合作方或第三方開發者能自助串接，不用一直 ping 你解釋。

指令介紹

「你們的 API 怎麼用？」這句話讓後端工程師又愛又恨——愛的是有人要用，恨的是明明有文件還要解釋。API 文件寫不好，串接方就算有文件也看不懂，反而製造更多溝通成本。好的 API 文件讓開發者在三十分鐘內自己搞定，不需要問任何人。這組指令幫你把 API 規格轉換成讓人真正看得懂的說明文件。

適用情境

API文件技術文件RESTfulSwagger

懶人貼上・複製就能用

已填好範例複製就能直接用

帶去 ChatGPT 帶去 Claude

▸ 想換成你自己的內容？點開填一填選填

API 名稱與用途

Endpoint 與 HTTP method

請求參數

回應格式

⬇ 匯出此指令 CSV

AI 指令庫編輯的話

編輯實測好的 API 文件把「開發者從零到第一次成功呼叫」所需的所有資訊集中在一頁，可執行的 curl 範例是關鍵，讓開發者能立刻驗證；錯誤代碼附解決方式，把文件從「說明書」升級為「除錯指南」。這組「API 文件說明撰寫指令｜讓串接方不用一直來問你怎麼用」是 Prompts 編輯團隊實測整理的職場 AI 指令（Prompt），適合用 ChatGPT、Claude 執行，特別適合「0」等台灣在地場景。複製上方指令範本即可使用，免費、免註冊。

模型實測對照

## 商品搜尋 API 根據關鍵字搜尋商品清單，支援分頁與價格排序。 ### Request **Method：** `GET` **URL：** `/api/v1/products/search` **Headers：** `Authorization: Bearer {token}` | 參數 | 位置 | 必填 | 型別 | 說明 | 預設值 | |------|------|------|------|------|--------| | keyword | query | ✅ | string | 搜尋關鍵字 | — | | page | query | ❌ | integer | 頁碼 | 1 | | limit | query | ❌ | integer | 每頁筆數（最大 100）| 20 | | sort_by | query | ❌ | string | `price_asc`/`price_desc` | — | ### 請求範例 ```bash curl -X GET "https://api.example.com/api/v1/products/search?keyword=耳機&page=1&limit=20&sort_by=price_asc" \ -H "Authorization: Bearer eyJhbG..." ``` ### Response 範例（成功） ```json { "data": [ {"id": 123, "name": "Sony WH-1000XM5", "price": 9900, "sku": "SONY-WH-XM5"} ], "meta": {"total": 128, "page": 1, "limit": 20, "next_cursor": "eyJpZCI6MTIzfQ"} } ``` ### 錯誤代碼 | 代碼 | 說明 | 解決方式 | |------|------|----------| | 400 | keyword 未填或為空白 | 確認 keyword 參數存在 | | 401 | Token 無效或過期 | 重新取得 access token | | 422 | limit 超過 100 | 將 limit 設為 100 以下 |

實測（ChatGPT）：參數表格含必填/型別/說明/預設值四欄，curl 範例可直接複製執行，錯誤代碼表格附解決方式，讓串接方真的能自助 debug，不需要 ping 後端。

產出完整 API 文件：功能一行說明、四欄位參數表格（必填/型別/說明/預設值）、可複製 curl 範例、成功與錯誤 JSON 範例、三種錯誤代碼對照表含解決方式，全 Markdown 格式。

實測（Claude）：把 curl 範例和 JSON response 並排展示，讓開發者不用猜測 request 格式，直接測試就能確認是否串接成功。