BIRLIARY: Ist es möglich, zu dokumentieren, welche JSON-Antwortfelder sind?

Question

Ich möchte dokumentieren, was die eigentlichen JSON-Felder selbst repräsentieren.

Ich habe die GET-Anweisung und -parameter dokumentiert, aber dies ergibt keine vollständige Dokumentation, um Benutzern zu geben.

Also, im Beispiel unten, wie würde ich einen Kommentar zu "Anderefields" hinzufügen?Ist das unterstützt?Oder muss ich ein Begleitdokument woanders machen.

generasacodicetagpre.

Answer 1

update: Wir haben gerade eine Beta von Attribute-Beschreibung mit dem MSON Syntax .

Die ursprüngliche Nutzlast könnte dann als

beschrieben werden generasacodicetagpre.

Hinweis Die explizite JSON im Körper ist redundant und Sie können es vollständig überspringen.Siehe API Blueprint-Spezifikation - Attribute Weitere Informationen

Answer 2

Ich glaube nicht, dass es noch unterstützt wird.

Ich habe dieses Problem in meinem Projekt gelöst, indem ich eine Tabelle mit der Beschreibung direkt über der RET-Anforderungszeile setzte.In Ihrem Fall könnte es aussehen:

generasacodicetagpre.

Um Ihnen zu helfen, die Tabelle in der Markdown-Syntax zu erstellen, können Sie Kennzeichnungstabellen Generator verwenden.

Beachten Sie, dass der Tabellengenerator die Tabellendefinition in einer Datei speichern lässt, also das nächste Mal, wenn Sie das nächste Mal benötigen, um die Tabelle zu bearbeiten, die Sie anfangen können, woher Sie aufgehört haben.