Kann ich mehrere Beispielantworten angeben?

8

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:

  1. Einer der API-Aufrufe hat den Parameter include , mit dem der Benutzer einige zusätzliche Felder angeben kann, die in die Antwort
  2. aufgenommen werden sollen
  3. Bei einigen API-Aufrufen hängen die in der Antwort enthaltenen Felder von Berechtigungen ab, die dem API-Schlüssel des Benutzers zugeordnet sind

Was ich gerne tun könnte, ist etwa so:

%Vor%

Soweit ich das beurteilen kann, können Sie zwar mehrere Antworten bereitstellen, dies jedoch nur, wenn der Antwortcode oder Inhaltstyp unterschiedlich ist. Gibt es eine Möglichkeit, dies zu tun?

    
Tim Fountain 24.02.2014, 13:18
quelle

1 Antwort

5

Aktualisieren : Dies wurde bereits implementiert siehe API-Blueprint-Spezifikation .

Ursprüngliche Antwort:

TL; DR: Nicht unterstützt, geplant

  

Soweit ich das beurteilen kann, können Sie zwar mehrere Antworten bereitstellen, dies jedoch nur, wenn der Antwortcode oder Inhaltstyp unterschiedlich ist.

Ihre Ergebnisse sind in der Tat richtig. Es gibt derzeit keine Möglichkeit, dies zu tun. Ich habe in letzter Zeit viel über diese Idee nachgedacht. Die Lösungen scheinen diese Einschränkung aufzuheben und implementieren die impliziten Transaktionsbeispiele - Automatische Anforderungsantwort-Paarung a>.

Beachten Sie, dass dies in Ihrem Fall wie zwei verschiedene Transaktionsbeispiele auf der Grundlage der Anfrage erscheint

(Pseudocode):

%Vor%

Wenn include=telephone ein URI-Abfrageparameter ist, benötigt diese geplante Funktion neben der automatischen Paarung auch die Syntax für Beschreibung der URI-Parameterwerte .

    
Zdenek 25.02.2014, 20:19
quelle

Tags und Links