Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.81 KB

2-04-json-ausgabe.md

File metadata and controls

47 lines (31 loc) · 1.81 KB

JSON-Ausgabe {#json-ausgabe}

Ein OParl-Server muss Objekte in Form von JSON ausgeben. Die Abkürzung JSON steht für "JavaScript Object Notation". Das JSON-Format ist in RFC4627^[RFC4627: https://tools.ietf.org/html/rfc4627] beschrieben.

Sämtliche JSON-Ausgabe muss in UTF-8 ohne Byte Order Mark (BOM) geschehen. Dies entspricht RFC 7159 Section 8.11. Gemäß RFC 7159 Section 72 darf UTF-8 String-Escaping verwendet werden. XML-/HTML-String-Escaping darf nicht verwendet werden.

Eine Syntaxübersicht und weitere Implementierungshinweise finden sich auf json.org.

In OParl verwendete Datentypen

In OParl werden alle in JSON definierten Dateitypen verwendet:

object: : Objects entsprechen der Definition des Objects in RFC 7159 Section 4

array: : Arrays entsprechen der Definition des Arrays in RFC 7159 Section 5

integer: : Integers entsprechen der Definition des Integer-Parts der Number aus RFC 7159 Section 6

boolean: : Booleans entsprechen der Definition von Boolean in RFC 7159 Section 3

string: : Strings entsprechen der Definition der Unicode-Strings aus RFC 7159 Section 7

In OParl werden verschiedene String-Typen verwendet. Wenn von diesen Typen gesprochen wird, so wird automatisch ein JSON-String vorausgesetzt:

url: : Eine URL ist ein String, der entsprechend dem Kapitel zu URLs formatiert wurde.

url (Object): : Eine url mit in Klammern angehängtem Object beschreibt eine URL auf eben diesen Objekttypus.

date-time: : Ein date-time entspricht einem Datum und ggf. einer Uhrzeit, wie sie im zugehörigen Kapitel beschrieben werden.

Footnotes

  1. RFC 7159 Section 8.1

  2. RFC 7159 Section 7