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.
- Quelle
- Ofox
So funktioniert’s
- 1
Auf „Genauso erstellen“ tippen
Ofox Chat öffnet sich mit der fertigen Struktur dieses Dokuments. Melde dich vorher an, falls nötig.
- 2
Anpassen
Ändere die markierten Stellen im Prompt und setze deine eigenen Details ein.
- 3
Senden und erstellen
Sende ihn ab – Ofox Chat schreibt das komplette Dokument zum Herunterladen. Chatte weiter, um es zu überarbeiten.
Häufige Fragen
Was für eine Datei bekomme ich?
Ein vollständiges Dokument zum Herunterladen (Word oder PDF) – nicht nur ein Textblock im Chat.
Muss ich etwas vorbereiten?
Nein – du kannst direkt senden, und Ofox Chat schreibt eine erste Fassung nach der Vorlage. Gib Hintergrund, Daten oder vorhandene Dokumente mit (eingefügt oder als PDF, Word usw. hochgeladen), dann passt das Ergebnis deutlich besser zu deiner Situation.
Kann ich den Prompt bearbeiten?
Ja. Der Prompt landet im Eingabefeld von Ofox Chat – vor dem Senden kannst du das Thema durch dein eigenes ersetzen, Anforderungen ergänzen oder Unnötiges streichen.
Kann ich den Prompt direkt kopieren und verwenden?
Ja. Tippe auf „Kopieren“ auf der Prompt-Karte, um den reinen Text zu erhalten – er funktioniert auch in anderen KI-Schreibtools.
Ähnliche Ergebnisse
Mehr Entwicklung-Prompts- Technical design docExplain how a system or feature will be built—architecture, data model, APIs and alternatives—and assess performance, risks, rollout and rollback.Entwicklung
- Incident postmortemReconstruct a production incident on a timeline, quantify its impact, trace the root cause, and set owned, dated actions to prevent a repeat.Entwicklung
- Technology evaluationWeigh candidate technologies against criteria set by business needs, score them with evidence, and recommend one with risks and a rollout plan.Entwicklung
- Test planDefine what to test, how, where, and when testing is done for a release or project, aligning QA, engineering and product on expectations.Entwicklung
- Release runbookTurn a deployment into a step-by-step runbook: pre-release checks, numbered steps, post-release verification, and rollback with clear triggers.Entwicklung
- Coding standardsSet shared coding standards: rules ranked must vs. should for naming, structure, error handling, security and reviews, each with examples.Entwicklung
- Database design docDocument the data layer: entity relationships, tables and constraints, the query behind each index, volume estimates and archiving.Entwicklung
- Migration planPlan a system or data migration: inventory, strategy, data sync and validation, phased cutover, and rollback at every stage.Entwicklung
- Performance test reportReport a performance test: throughput, latency percentiles and resource use against targets, the bottlenecks found, and a go/no-go call.Entwicklung
- Security reviewWrite up a security assessment: scope, threat model, findings with risk ratings and evidence, fixes, and a remediation and retest plan.Entwicklung
Eigene Idee? Leg direkt los
Beschreibe dein Wunschbild in einem Satz – Ofox Chat erstellt es von Grund auf.