Ich probiere API Blueprint aus und finde einige Dinge, die mir nicht ganz klar sind.
Es gibt + Parameters , aber es dokumentiert nur Abfrageparameter. Wenn ich nun eine POST-API beschreiben möchte, kann ich keine POST-Parameter (application / x-www-form-urlencoded) dokumentieren. Das gleiche gilt für JSON (siehe # 3).
Ich habe es versucht
%Vor%Aber das fügt nur den Text als die Körperantwort hinzu.
Wenn ich JSON zurücksende, möchte ich jedes Feld einzeln beschreiben, seinen Typ und seinen Zweck. Gibt es eine Möglichkeit, das zu tun?
Danke!
Sehen wir uns # 1 und # 3 zusammen an, da sie eng miteinander verwandt sind:
Gegenwärtig gibt es keine dedizierte Syntax, um die tatsächlichen Felder eines Nutzlast (Modell, Antwort oder Anfrage).
Nun liegt es an Ihnen, wie Sie es mit einer beliebigen Markdown-Syntax beschreiben.
Der Plan ist, eine Markdown-Syntax zur Diskussion dieser Felder / Parameter wie folgt zur Verfügung zu stellen:
JSON:
%Vor%und seine Beschreibung im Blueprint:
%Vor%Ich arbeite gerade daran. Weitere Details finden Sie hier .
Sie können bereits eine abgelegte formatierte Diskussion zu einer Payload hinzufügen
%Vor%Weitere Informationen finden Sie hier: Ссылка
Hinweis: Damit die Beschreibung in Imkerei korrekt angezeigt wird, müssen Sie möglicherweise das New Apiary gerendert Dokumentation
Tags und Links apiblueprint