Datenstruktur

JSON Schema für POST und PUT von Wishes

Mithilfe des Modules "jsonschema" haben wir ein JSON Schema zur Validierung beim POST und PUT von Wishes erstellt. Mit diesem Schema sichern wird ab, das diese beiden Methoden die nötigen und validen Daten liefern. Diese beiden Methoden sind beispielhaft ausgewählt, da der Validierungsprozess natürlich noch viel weiter verbessert werden könnte.

  "definitions": {},
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "title": "JSON Schema",
  "required": [
    "location",
    "name"
  ],
  "properties": {
    "location": {
      "$id": "#/properties/location",
      "type": "string",
      "title": "The Location Schema",
      "default": "",
      "examples": [
        false
      ],
      "pattern": "^(.*)$"
    },
    "user": {
      "$id": "#/properties/user",
      "type": "string",
      "title": "The User Schema",
      "default": "",
      "examples": [
        false
      ],
      "pattern": "^(.*)$"
    },
    "name": {
      "$id": "#/properties/name",
      "type": "string",
      "title": "The Name Schema",
      "default": "",
      "examples": [
        false
      ],
      "pattern": "^(.*)$"
    }
  }
}

Beispiel JSON Strukturen für die POSTs auf Dienstgeber

Users

{"name": "Rudi"}

Events

{"name":"Gemütliches Grillen im Denkmalweg"}

Wishes

{
    "name":"Wurst",
    "location" : "Metzger",
    "user" : "816227012973" //ID des Users
}

Shoppinglist

{
   //Daten werden automatisch generiert
}