API reference
Document auth, conventions, error codes, and each endpoint's parameters and examples so developers can complete the integration on their own.
提示詞
Write API documentation for a loyalty points system's public API. Purpose: let partner developers integrate on their own. Requirements: give base URLs per environment, authentication and common conventions (request format, pagination, idempotency, rate limits, time format), an error code table and endpoint index; for each endpoint, the method and path, request parameter and response field tables, and success and error examples; for webhooks, signature verification and retries; plus a changelog. Be exact about types and required fields, use placeholder keys, and keep it concise.
- 來源
- Ofox
如何使用
- 1
點擊「做同款」
進入 Ofox Chat，這份文稿的結構已經替你準備好。未登入時請先登入。
- 2
改成你想要的
提示詞裡高亮的部分可以直接改，換成你自己的內容。
- 3
送出並生成
傳送後 Ofox Chat 寫出完整文件，可以直接下載；不滿意可以繼續對話修改。
常見問題
產生的是什麼格式的檔案？
一份結構完整、可下載的文件（Word 或 PDF），不只是對話裡的一段文字。
需要準備資料嗎？
不準備也可以直接傳送，Ofox Chat 會先依範本寫出一版。把背景資料、數據或既有文件一起傳過去（直接貼上，或上傳 PDF、Word 等檔案），寫出來會更貼近你的實際情況。
可以修改提示詞嗎？
可以。提示詞會填進 Ofox Chat 的輸入框，傳送前可以換成你自己的主題、補充要求，或刪掉不需要的部分。
提示詞可以直接複製使用嗎？
可以。點提示詞卡片右上角的「複製」即可取得純文字，也能用在其他 AI 寫作工具裡。
更多同類
更多研發提示詞- Technical design docExplain how a system or feature will be built—architecture, data model, APIs and alternatives—and assess performance, risks, rollout and rollback.研發
- Incident postmortemReconstruct a production incident on a timeline, quantify its impact, trace the root cause, and set owned, dated actions to prevent a repeat.研發
- Technology evaluationWeigh candidate technologies against criteria set by business needs, score them with evidence, and recommend one with risks and a rollout plan.研發
- Test planDefine what to test, how, where, and when testing is done for a release or project, aligning QA, engineering and product on expectations.研發
- Release runbookTurn a deployment into a step-by-step runbook: pre-release checks, numbered steps, post-release verification, and rollback with clear triggers.研發
- Coding standardsSet shared coding standards: rules ranked must vs. should for naming, structure, error handling, security and reviews, each with examples.研發
- Database design docDocument the data layer: entity relationships, tables and constraints, the query behind each index, volume estimates and archiving.研發
- Migration planPlan a system or data migration: inventory, strategy, data sync and validation, phased cutover, and rollback at every stage.研發
- Performance test reportReport a performance test: throughput, latency percentiles and resource use against targets, the bottlenecks found, and a go/no-go call.研發
- Security reviewWrite up a security assessment: scope, threat model, findings with risk ratings and evidence, fixes, and a remediation and retest plan.研發
有自己的想法？直接開始創作
在 Ofox Chat 裡用一句話描述你想要的畫面，從零生成屬於你的作品。