JSON-schema

[Verwijderd]

Beste,

Ik zit met een JSON-schema probleempje.
Ik heb bijvoorbeeld in JSON een aantal pages:

"pages": [
{
"id": "home-simple-1",
"name": "Home"
},
{
"id": "home-simple-2",
"name": "Home"
},
{
"id": "random-iets-anders",
"name": "Home"
}
]

Nu wil ik zo instellen, dat alle pages (dus de items) uit "pages" voldoen aan:

"id": {
"type": "string",
"pattern": "^[a-z0-9-]+$",
"description": "Het unieke page-id die een page-template onderscheid."
},

(Dat werkt overigens al).
Echter wil ik ook valideren dat er altijd 2 pages in de JSON zitten met page-id: "home-simple-1" en "home-simple-2". Deze 2 pages moeten namelijk altijd present zijn.

Ik kan met een pattern instellen dat een id gelijk is aan "home-simple-1" of zelf "home-simple-2". Dit doe ik met AnyOf of OneOf. Maar als ik GEEN pages opneem met "home-simple-1" of "home-simple-2", dan valideert deze dus ook..

Weet iemand de juiste manier hiervoor?

[DJMaze]

Gewoon iets met

code:

for i = 0; i < pages.length; ++i
   if ('home-simple-1' == pages[i].id) { /* doe iets */ }
   if ('home-simple-2' == pages[i].id) { /* doe iets */ }

[CyBeRSPiN]

Al naar http://swagger.io/ gekeken?

[CodeCaster]

DJMaze schreef op maandag 5 december 2016 @ 17:32:
Gewoon iets met

code:

for i = 0; i < pages.length; ++i
   if ('home-simple-1' == pages[i].id) { /* doe iets */ }
   if ('home-simple-2' == pages[i].id) { /* doe iets */ }

Waarmee je dus het hele nut van schemavalidatie omzeilt.

CyBeRSPiN schreef op maandag 5 december 2016 @ 17:34:
Al naar http://swagger.io/ gekeken?

Wat zou Swagger hier precies voor TS kunnen betekenen, en waarom link je dan naar de homepagina?

---

TS, je bent op zoek naar "allOf". Hiermee definieer je meerdere schema's die je op één property kunt toepassen.

Zie het volgende schema:

JavaScript:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "definitions": {
    "page": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "properties": {
    "pages": {
      "allOf": [
        {
          "type": "array",
          "items": [
            {
              "type": "object",
              "properties": {
                "id": {
                  "enum": [
                    "home-simple-1"
                  ]
                }
              }
            },
            {
              "type": "object",
              "properties": {
                "id": {
                  "enum": [
                    "home-simple-2"
                  ]
                }
              }
            }
          ],
          "additionalItems": true
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/definitions/page"
          }
        }
      ]
    }
  }
}

Je ziet eerst de definitie van een "page", gevolgd door het daadwerkelijke schema. Hierin worden er twee validaties over de pages-property gehaald:

• Tuple validation:
• • Het eerste element moet een id-property hebben met de waarde "home-simple-1"
• • Het tweede element moet een id-property hebben met de waarde "home-simple-2"
• • Hierna mogen nog meer elementen volgen
• List validation:
• • Ieder item in deze array moet voldoen aan de definitie van het page-object.

[Verwijderd]

Thanks! Dit is precies wat ik zocht!

Ik ga het morgen even implementeren, feedback stuur ik dan morgen.

Wat betreft de if statements, ja dit kan. Maar dan valt het schema validatatie principe gewoon weg zoals al aangegeven.

Swagger io is helaas ook niet wat ik zocht.

[Verwijderd]

Het werkt!! Thanks

[Olaf van der Spek]

CodeCaster schreef op maandag 5 december 2016 @ 18:16:
TS, je bent op zoek naar "allOf". Hiermee definieer je meerdere schema's die je op één property kunt toepassen.

Welke functie / library / framework gebruik je om te controleren of een instance inderdaad aan het schema voldoet?

[Barryvdh]

Olaf van der Spek schreef op woensdag 7 december 2016 @ 14:48:
[...]

Welke functie / library / framework gebruik je om te controleren of een instance inderdaad aan het schema voldoet?

In PHP kan je deze gebruiken bijvoorbeeld: http://json-guard.thephpleague.com

[CodeCaster]

Olaf van der Spek schreef op woensdag 7 december 2016 @ 14:48:
[...]

Welke functie / library / framework gebruik je om te controleren of een instance inderdaad aan het schema voldoet?

Hangt van het framework af. Voor .NET is er van de welbekende James Newton-King (Newtonsoft.Json, de de facto JSON-library) het package "Newtonsoft.Json.Schema". Bovenstaand schema heb ik online gebouwd en gevalideerd via http://www.jsonschemavalidator.net/.

[ Voor 3% gewijzigd door CodeCaster op 07-12-2016 18:59 ]

[Olaf van der Spek]

Maar dan heb ik slechts schema validatie.. is het niet beter de API op een hoger niveau te testen?
Ik kwam https://github.com/apigee-127/swagger-test-templates tegen maar weet niet of dat de beste optie is.