Technische Arbeit mit Code und Feldtabellen erklären
Halten Sie Endpunktbeschreibung, Anfragebeispiel und Antwort neben der Designdiskussion bereit. API Documentation beginnt mit bearbeitbarem Text und nativen Code block-Objekten für HTTP- und JSON-Beispiele. Passen Sie den Beispielvertrag an, ergänzen Sie bei Bedarf eine Feldtabelle und halten Sie Ausschnitte lesbar. Der Canvas wird zur visuellen technischen Referenz, die sich mit der Schnittstelle weiterbearbeiten lässt.
Canvas → Templates → API Documentation → Code block → Code languageDas lernen Sie
- Native Codeblöcke bearbeiten und ihre Anzeigesprache wählen.
- Anfrage-, Erfolgs- und Fehlerbeispiele konsistent halten.
- Feldanforderungen in einem bearbeitbaren Raster vergleichen.
In Boilerrum mit einem Beispielprojekt aufgenommen. Die App-Oberfläche ist auf Englisch zu sehen.
In dieser Anleitung
01
Mit der Endpunktreferenz beginnen
Suchen Sie unter Templates nach API Documentation und wählen Sie Use template. Prüfen Sie Request, Response / 201 Created, Request fields und Error / 400 Bad Request. Ersetzen Sie Titel, Endpunkt und Erklärungen durch den zu besprechenden Vertrag. api.example.com und die Aufgabendaten sind Beispiele; prüfen Sie sie, bevor das Board als Referenz dient.
02
Den Anfragecode bearbeiten
Wählen Sie den Anfrage-Code block und doppelklicken Sie auf die Vorschau oder drücken Sie am fokussierten Block Enter beziehungsweise F2. Bearbeiten Sie die Anfrage in Code content. Wählen Sie im Kopfbereich über Code language HTTP, JSON oder eine andere passende Sprache. Escape führt zur Vorschau zurück. Prüfen Sie Inhalt und Sprache dieses Blocks.
03
Erfolg und Fehler gemeinsam erklären
Bearbeiten Sie Antwort- und Fehlerblock einzeln und wählen Sie jeweils die passende Code language. Stimmen Sie Feldnamen, Kennungen und Statusangaben mit der Anfragebeschreibung ab. Ergänzen Sie beim Fehler einen kurzen Satz zum nächsten Schritt des Aufrufers. Es handelt sich um dokumentierte Prüfbeispiele; gleichen Sie sie mit dem vom Team gepflegten Vertrag ab.
04
Feldanforderungen vergleichen
Öffnen Sie für einen kompakten Vergleich Grid tools und wählen Sie vier Zeilen und vier Spalten. Tragen Sie per Doppelklick Field, Type, Required und Meaning in die Kopfzeile ein und beschreiben Sie darunter drei Anfragefelder. Stellen Sie das Raster neben den Code und vergleichen Sie die Namen. Behalten Sie vorhandene Textzeilen nur als hilfreiche Ergänzung.
05
Die Referenz prüfen und nutzbar halten
Verlassen Sie die Codebearbeitung und prüfen Sie die gesamte Referenz mit Fit view. Kontrollieren Sie lange Zeilen, kleine Tabellentexte und die Übereinstimmung von Erfolgs- und Fehlerbeispielen mit Feldbeschreibungen. Speichern Sie den Canvas. Für Prüfunterlagen ergänzen Sie einen Frame und exportieren ihn über Present → Frame options. Prüfen Sie die Datei und behalten Sie die bearbeitbaren Blöcke.
Ihr Canvas erklärt den Endpunkt mit konsistenten Anfrage-, Antwort- und Fehlerbeispielen sowie einem lesbaren Feldvergleich. Das Team kann den Vertrag visuell prüfen und das technische Original direkt bearbeiten.