Benutzerdefinierte Abfrage Parameternamen in RAML

Ich versuche RAML zu verwenden folgenden API-AufrufBenutzerdefinierte Abfrage Parameternamen in RAML

PUT /api/v1/kv_store?{key}={value}

Es ist eine einfache Schlüssel-Wert-Speicherung zu beschreiben. Ich muss angeben, dass key Wert eine beliebige Zeichenfolge sein kann, und API-Konsole sollte Benutzern die Möglichkeit geben, es sowie alle anderen Parameter einzugeben.

Ist es überhaupt machbar? Ich lese RAML 1.0 Spezifikation und kann keinen Weg finden, es zu tun, so kleines Beispiel wird wirklich großartig.

Quelle

2016-04-04 cleg

Nicht sicher gerecht, wenn es machbar ist, aber wenn Sie Ihre API 'ändern würde? Key = {} & value = {Wert}' es würde dann angeben leicht zu. –

Sicher, es ist eine Lösung, aber die Änderung API ist ziemlich schmerzhaft, und "machen es leicht beschreibbar durch RAML" ist kein guter Grund, leider – cleg

Gotcha, war ich nicht sicher, ob Sie Spielraum hatten, Ihre API zu überdenken oder nicht . –

Sie tun es völlig falsch. lesen Sie bitte Documentation.

Korrekter Weg zur Implementierung QueryParameters mit folgendem Code. Da dies Ihr http://api/v1/kv_store/

/songs: 
    put: 
    queryParameters: 
     id: number 
     name: string 
     type: string 
     album: number

Quelle

2017-05-11 11:35:18 Hemin

Ich habe diese Frage gestellt, weil ich es so machen musste. Ich brauchte eine Möglichkeit, einen variablen Parameternamen zu haben, nicht einen festen. – cleg

Benutzerdefinierte Abfrage Parameternamen in RAML

Antwort

Verwandte Themen