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가 처음부터 만들어 드립니다.