apiblueprint

API Blueprint ist eine Markdown-basierte DSL zur Beschreibung von HTTP-APIs.
1
Antwort

Antwortbeschreibung und POST-Parameter in API Blueprint

Ich probiere API Blueprint aus und finde einige Dinge, die mir nicht ganz klar sind. 1. Wie kann ich POST-Body-Parameter dokumentieren? Es gibt + Parameters , aber es dokumentiert nur Abfrageparameter. Wenn ich nun eine POST-API beschrei...
19.05.2014, 10:44
2
Antworten

So zeigen Sie die geschachtelte Attributdefinition in Apiary.io

Ich habe eine Datenstruktur wie folgt definiert: %Vor% Ich versuche, diese Datenstruktur in einer anderen Aktionsdefinition wie folgt zu verwenden: %Vor% Ich möchte, dass die Apiary.io-Dokumentation nicht nur die Attribute der obersten E...
14.05.2015, 11:59
1
Antwort

Kann ich mehrere Beispielantworten angeben?

Ich schreibe eine Spezifikation für eine API, bei der die Felder in der Antwort variieren. Ich würde gerne mehr als ein Beispiel geben können, um dies zu zeigen. Meine Anwendungsfälle sind: Einer der API-Aufrufe hat den Parameter include ,...
24.02.2014, 13:18