JSON-WSP ist ein Webdienstprotokoll , das JSON für Dienstbeschreibungen, Anfragen und Antworten verwendet . [ 1 ]
Überblick
Es ist von JSON-RPC inspiriert , aber das Fehlen einer Dienstbeschreibungsspezifikation mit Dokumentation in JSON-RPC gab den Anstoß zur Entwicklung von JSON-WSP.
Das Beschreibungsformat von JSON-WSP erfüllt denselben Zweck wie die Web Services Description Language (WSDL) für SOAP oder die Interface Description Language (IDL) für die Common Object Request Broker Architecture (CORBA): die Beschreibung der in einem Dienst verwendeten Typen und Methoden. Es beschreibt außerdem Beziehungen zwischen Typen (d. h. verschachtelte Typen) und definiert, welche Typen als Methodenargumente erwartet werden und welche Typen der Benutzer als Rückgabewerte erwarten kann. Schließlich ermöglicht die Beschreibung die Ergänzung der Dokumentation auf Dienst-, Methoden-, Parameter- und Rückgabeebene.
Die Kommunikation zwischen Clients und einem JSON-WSP-Server erfolgt mittels HTTP- POST- Anfragen [ 2 ] und -Antworten, wobei die JSON-Objekte als Daten mit dem Inhaltstyp application/json verwendet werden. [ 3 ]
Spezifikationen
JSON-WSP besteht aus vier JSON-Objektspezifikationen:
| Spezifikation | Beschreibung |
|---|---|
| Beschreibung | Die Dienstbeschreibungsspezifikation (ähnlich wie WSDL ) beschreibt Methoden, Methodenparameter, Typen und Rückgabetypen. Sie unterstützt außerdem die Benutzerdokumentation auf Dienst-, Methoden- und Parameterebene. |
| Anfrage | Spezifikation für JSON-Anfragen. Sie enthält Informationen darüber, welche Methode aufgerufen werden soll und alle Argumente für den Methodenaufruf. Die Argumente in der Anfrage müssen der Parameterdefinition derselben Methode in der zugehörigen JSON-WSP-Beschreibung entsprechen. |
| Antwort | Spezifikation für JSON-Antworten. Das Antwortobjekt enthält das Ergebnis eines Dienstmethodenaufrufs. Der Rückgabetyp muss dem in der zugehörigen JSON-WSP-Beschreibung definierten Rückgabetyp derselben Methode entsprechen. |
| Fehler | Spezifikation für JSON-Fehlerantworten. Das Fehlerobjekt enthält einen Fehlercode und eine Fehlerzeichenfolge. Die Fehlerinformationen geben an, ob der Fehler client- oder serverseitig aufgetreten ist. Abhängig vom serverseitigen Service-Framework können detailliertere Informationen extrahiert werden, z. B. der Dateiname und die Zeilennummer, in der der Fehler aufgetreten ist. |
Referenzen
- ^ „ECMAScript – 2017 Language Specification“ (PDF) . Ecma-international.org . Archiviert vom Original (PDF) am 12. April 2015. Abgerufen am 28. Januar 2018 .
- ^ Roy, Fielding; Julian, Reschke (2014). Fielding, R.; Reschke, J. (Hrsg.). „Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content“ . Tools.ietf.org . doi : 10.17487/RFC7231 . S2CID 14399078. Abgerufen am 28. Januar 2018 .
- ^ „RFC 4627“ . Archiviert vom Original am 17.07.2011 . Abgerufen am 14.02.2011 .
