API Referenz: Endpunkte & Authentifizierung

1. JSON validieren

Sende den JSON-String als Query-Parameter oder im Body als raw-Feld:

curl -X GET "https://api.json-werkstatt.de/v1/validate?strict=true&raw={%22name%22:%22Lena%22,%22alter%22:31}" \
  -H "Authorization: Bearer jwt_7f3a9c2e1d8b4f6a5e0c9d7b3a1f8e2c4d6b0a9f7e3c1d5b8a2f4e6c0d9b7a3"

Antwort:

{
  "valid": true,
  "checkedAt": "2024-11-03T14:22:17Z"
}

2. JSON formatieren

Eingabedaten im Body, Formatierungsoptionen als Query:

curl -X POST "https://api.json-werkstatt.de/v1/format?indent=4&sortKeys=true" \
  -H "Authorization: Bearer jwt_7f3a9c2e1d8b4f6a5e0c9d7b3a1f8e2c4d6b0a9f7e3c1d5b8a2f4e6c0d9b7a3" \
  -H "Content-Type: application/json" \
  -d '{"zuletzt":"2024-11-03","name":"Lena","alter":31}'

Antwort:

{
  "formatted": "{\n    \"alter\": 31,\n    \"name\": \"Lena\",\n    \"zuletzt\": \"2024-11-03\"\n}",
  "byteSize": 67
}

3. JSON nach YAML konvertieren

curl -X POST "https://api.json-werkstatt.de/v1/convert?from=json&to=yaml" \
  -H "Authorization: Bearer jwt_7f3a9c2e1d8b4f6a5e0c9d7b3a1f8e2c4d6b0a9f7e3c1d5b8a2f4e6c0d9b7a3" \
  -H "Content-Type: application/json" \
  -d '{"name":"Lena","projekte":["json-toolkit","data-pipeline"],"aktiv":true}'

Antwort:

{
  "converted": "name: Lena\nprojekte:\n  - json-toolkit\n  - data-pipeline\naktiv: true\n",
  "targetFormat": "yaml"
}

4. Schema-Validierung

curl -X POST "https://api.json-werkstatt.de/v1/schema" \
  -H "Authorization: Bearer jwt_7f3a9c2e1d8b4f6a5e0c9d7b3a1f8e2c4d6b0a9f7e3c1d5b8a2f4e6c0d9b7a3" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {"name":"Lena","alter":31},
    "schema": {
      "type":"object",
      "required":["name","email"],
      "properties":{"name":{"type":"string"},"email":{"type":"string"}}
    }
  }'

Antwort (fehlerhaft):

{
  "valid": false,
  "violations": [
    {
      "path": "$",
      "message": "Fehlendes erforderliches Feld 'email'"
    }
  ]
}

5. JSON-Diff

curl -X POST "https://api.json-werkstatt.de/v1/diff" \
  -H "Authorization: Bearer jwt_7f3a9c2e1d8b4f6a5e0c9d7b3a1f8e2c4d6b0a9f7e3c1d5b8a2f4e6c0d9b7a3" \
  -H "Content-Type: application/json" \
  -d '{
    "before": {"name":"Lena","alter":30,"stadt":"Berlin"},
    "after": {"name":"Lena","alter":31,"stadt":"München","rolle":"Lead"}
  }'

Antwort:

{
  "added": ["$.rolle"],
  "removed": [],
  "changed": ["$.alter", "$.stadt"],
  "unchanged": ["$.name"]
}