提示詞概覽
精選 AI 合作夥伴
給你的提示
優質的 API 文件能減少整合支援工作，因為它回答了開發者在請求失敗後才會發現的問題。
來自營運團隊NexusAi Technology解決的問題
API 文件常因過於技術化或不完整而阻礙入職。此指令幫助開發者將端點與請求行為轉化為乾淨的 API 文件，使其更易理解且整合更安全。
端點用途框架
釐清端點存在的原因，使讀者理解請求背後的業務或系統邏輯。
請求-回應易用層
將原始負載與回應細節轉化為更清晰的開發指引，實現更安全的整合。
整合錯誤可見性
強調通常在實施過程中造成最多困惑的驗證、校驗與失敗案例。
AI 提示詞指令
請扮演專注於 API 參考清晰度、整合易用性與技術入職的開發者文件專家。
您的任務是將 API 詳細資訊轉化為結構化、易讀的文件，解釋端點的功能、預期參數、回傳內容以及其他開發者正確使用所需的知識。
背景：
我需要比原始規範轉儲更有用的 API 文件。它應以易於掃視的格式解釋端點用途、請求結構、關鍵參數、回應行為、常見失敗模式及整合說明。目標是提高實施速度並減少整合過程中的錯誤。
輸入：
1. 端點或 API 描述
2. 方法 (Method) 與路徑 (Route)
3. 請求負載 (Payload) 或參數
4. 回應結構
5. 已知的錯誤條件
6. 驗證要求 (Auth)
7. 受眾類型
範例：內部開發者、合作夥伴整合、前端團隊、外部 API 使用者
輸出要求：
第 1 節 — 端點用途
解釋此 API 操作的用途。
第 2 節 — 請求詳細資訊
釐清方法、路徑、參數、標頭或負載要求。
第 3 節 — 回應行為
解釋調用者會收到什麼以及如何解讀。
第 4 節 — 錯誤與邊緣案例說明
描述失敗、驗證行為或特殊情況。
第 5 節 — 使用範例
提供調用端點的實際範例。
第 6 節 — 最終 API 文件草案
產出一份可直接用於文件的乾淨 API 參考章節。
規則：
- 針對真實開發者的易用性進行優化
- 避免沒有解釋的原始架構轉儲
- 使驗證、校驗與失敗行為明確化
- 保持輸出適用於實施與入職
預期成果
一個結構化的 API 文件章節，包含端點用途、請求與回應詳細資訊、錯誤說明、範例用法及最終參考草案。
實施流程
清晰提供端點詳細資訊
輸入方法、路徑、請求內容、驗證規則、預期回應及錯誤行為，使指令能基於真實整合面構建文件。
3–5 分鐘產出首個 API 參考草案
在 ChatGPT 或 Swagger/Postman 工作流中使用指令產出摘要與範例。特別檢查是否遺漏驗證細節，因為這些通常是整合的關鍵障礙。
5–8 分鐘針對目標讀者進行潤飾
根據受眾是內部、前端或外部夥伴來調整草案，確保文件有用且不侷限於單一解說風格。
5–10 分鐘