資料庫程式

API 文件撰寫指令

黃柏睿・技術編輯 ·被複製 280·最後更新 2026/06/09
適用模型ClaudeChatGPT
分享:
一句話結論把端點整理成清楚好讀的 API 文件。

指令介紹

寫 API 文件很花時間,又常常寫得不清楚,讓串接的人一直來問。這組指令會把你的端點資訊整理成結構清楚的文件,包含用途、請求方法與參數、回應範例、錯誤碼與注意事項,讓前端或第三方開發者看了就能串,減少溝通成本。

適用情境

API 文件技術文件串接說明團隊協作

懶人貼上・複製就能用

已填好範例複製就能直接用
▸ 想換成你自己的內容?點開填一填選填
⬇ 匯出此指令 CSV

AI 指令庫編輯的話

編輯實測指令依標準 API 文件結構整理,串接者一看就懂、少來問。 這組「API 文件撰寫指令」是 Prompts 編輯團隊實測整理的程式 AI 指令(Prompt),適合用 Claude、ChatGPT 執行。複製上方指令範本即可使用,免費、免註冊。

模型實測對照

## POST /api/login 用途:使用者登入 參數:email(string,必填) password(string,必填) 成功 200:{token} 失敗 401:{error} 注意:token 有效 24h。
實測(Claude):結構完整、可直接用,最實用。
產出 API 文件。
實測(ChatGPT):正確。

為這個指令評分

4.7
78 人評分 · 點星星評分

常見問題

多個端點行嗎?

可以,貼多個它會逐一整理。

能產 OpenAPI 嗎?

可以,請它輸出 OpenAPI/Swagger 格式。

相關指令

超推指令
Excel/試算表公式產生指令
ChatGPTGemini
符合台灣 程式 · 880
超推指令
SQL 查詢產生指令
ClaudeChatGPT
程式 · 722
產品需求規格(PRD)指令
ClaudeChatGPT
程式 · 670
超推指令
程式錯誤除錯分析指令
ClaudeChatGPT
程式 · 581
超推指令
程式碼審查意見指令
ClaudeChatGPT
程式 · 530
解釋程式碼指令
ClaudeChatGPT
程式 · 523

猜你喜歡

超推指令
繁中潤稿(去簡體化)指令
ClaudeChatGPTGemini
符合台灣 寫作 · 2,111
超推指令
求職履歷自傳改寫指令
ClaudeChatGPT
符合台灣 職場 #求職 · 1,791
實測推薦
學測國寫作文批改指令
ClaudeChatGPT
符合台灣 教育 #學測 · 1,594
文字潤飾指令
ClaudeChatGPT
寫作 · 1,509

留言討論

延伸閱讀
每週 5 組最新台灣 AI 指令,寄到你信箱
免費訂閱電子報,第一時間收到新指令與實測心得;現在訂閱立即領取「50 組必備 AI 指令懶人包」。
不寄垃圾信,隨時可取消訂閱。
↑↓ 選擇 · Enter 前往 · Esc 關閉 AI 語意搜尋
已複製 ✓