API reference
Document auth, conventions, error codes, and each endpoint's parameters and examples so developers can complete the integration on their own.
Prompt
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.
- Source
- Ofox
Comment l’utiliser
- 1
Cliquez sur « Créer le même »
Ofox Chat s’ouvre avec la structure de ce document déjà prête. Connectez-vous d’abord si ce n’est pas fait.
- 2
Personnalisez
Modifiez les parties surlignées du prompt pour y mettre vos propres détails.
- 3
Envoyez et créez
Envoyez-le : Ofox Chat rédige le document complet, prêt à télécharger. Continuez la conversation pour le retoucher.
Questions fréquentes
Quel type de fichier vais-je obtenir ?
Un document complet et téléchargeable (Word ou PDF), pas seulement un bloc de texte dans la conversation.
Dois-je préparer quelque chose ?
Non : vous pouvez l’envoyer tel quel et Ofox Chat rédige une première version à partir du modèle. Ajoutez votre contexte, vos données ou des documents existants (collés ou importés en PDF, Word, etc.) et le résultat collera bien mieux à votre situation.
Puis-je modifier le prompt ?
Oui. Le prompt est placé dans la zone de saisie d’Ofox Chat : avant l’envoi, vous pouvez remplacer le sujet par le vôtre, ajouter des exigences ou retirer ce qui ne sert pas.
Puis-je copier et utiliser le prompt directement ?
Oui. Touchez « Copier » sur la carte du prompt pour obtenir le texte brut ; il fonctionne aussi dans d’autres outils de rédaction IA.
Dans le même esprit
Plus de prompts « Ingénierie »- Technical design docExplain how a system or feature will be built—architecture, data model, APIs and alternatives—and assess performance, risks, rollout and rollback.Ingénierie
- Incident postmortemReconstruct a production incident on a timeline, quantify its impact, trace the root cause, and set owned, dated actions to prevent a repeat.Ingénierie
- Technology evaluationWeigh candidate technologies against criteria set by business needs, score them with evidence, and recommend one with risks and a rollout plan.Ingénierie
- Test planDefine what to test, how, where, and when testing is done for a release or project, aligning QA, engineering and product on expectations.Ingénierie
- Release runbookTurn a deployment into a step-by-step runbook: pre-release checks, numbered steps, post-release verification, and rollback with clear triggers.Ingénierie
- Coding standardsSet shared coding standards: rules ranked must vs. should for naming, structure, error handling, security and reviews, each with examples.Ingénierie
- Database design docDocument the data layer: entity relationships, tables and constraints, the query behind each index, volume estimates and archiving.Ingénierie
- Migration planPlan a system or data migration: inventory, strategy, data sync and validation, phased cutover, and rollback at every stage.Ingénierie
- Performance test reportReport a performance test: throughput, latency percentiles and resource use against targets, the bottlenecks found, and a go/no-go call.Ingénierie
- Security reviewWrite up a security assessment: scope, threat model, findings with risk ratings and evidence, fixes, and a remediation and retest plan.Ingénierie
Une idée bien à vous ? Lancez-vous
Décrivez l’image voulue en une phrase, Ofox Chat la crée à partir de zéro.