Zum Inhalt springen

Vorlage · Task

API-Endpunkt

Ein neuer oder geänderter Endpunkt, mit seinem Vertrag. Wann einsetzen: Ein anderes System, eine App oder ein Agent muss etwas lesen oder schreiben.

MarkdownMarkiert: hier ausfüllen
# [METHODE] /[pfad] [tut was] ## Intent[Welcher Client] muss [was lesen oder schreiben], damit [warum]. ## Context- Dienst: [`api/der-dienst`, Framework, wo die Routen liegen]- Authentifizierung: [wer aufrufen darf: angemeldete Person, Token, Rolle]- Vorbild-Endpunkt: [`pfad/zum/aehnlichen.js`] ## What to do1. `[METHODE] /[pfad]` anlegen, mit [Body- oder Query-Feldern samt Typen].2. [Status und Form] zurückgeben, z. B. `{ "id": "…", "status": "…" }`.3. [Was] mit [Status] und der Meldung „[Text]“ ablehnen.4. In [wo die API-Doku liegt] dokumentieren. ## Constraints- Bestehende Clients von [benachbartem Endpunkt] funktionieren weiter.- Nie [Felder, die privat bleiben müssen] zurückgeben. ## Out of scope- [Paginierung, Webhooks, andere Methoden] ## Open questions- [Wer ruft das noch auf, und darf sich die Form der Antwort noch ändern? Entfernen, sobald geklärt.] ## Acceptance checks- Eine gültige Anfrage liefert [Status] mit [Form]- Ein Aufrufer ohne [Berechtigung] bekommt [403], und nichts wird geändert- Ungültige Eingaben liefern [400] mit einer Meldung, die das Feld nennt- Der Endpunkt ist in [Ort] dokumentiert 

Geben Sie Ihrem nächsten Agenten einen Brief.

Kostenlos für bis zu 10 Personen, mit MCP für jeden Agenten. Keine Kreditkarte.