Een JSON Schema-concept maken uit gedocumenteerde velden
Een JSON Schema-concept maakt de verwachte gegevensstructuur expliciet. Het is nuttig als documentatie velden beschrijft, maar een machineleesbaar beginpunt voor validatie nodig is.
Begin met het juiste materiaal.
- Wat je aanlevert
- een zichtbare specificatie van een API-respons.
- Het beoogde resultaat
- Maak een JSON Schema-concept met behoud van de gedocumenteerde verplichte velden en markeer aannames.
Hoe de workflow werkt.
Koppel gedocumenteerde velden aan typen en vereisten en houd geneste objecten en arrays duidelijk. Markeer aannames over formaten, beperkingen en het schemadialect wanneer de bron ze niet specificeert.
Wat je in het resultaat controleert.
Valideer het schema en probeer voorbeelden die bekend geldig en ongeldig zijn. Maak niet elk gedocumenteerd veld verplicht en verzin geen beperkende regels alleen omdat ze een net schema opleveren.
Parse de JSON voordat je deze in een andere toepassing gebruikt en bekijk de echte waarden. Geldige syntaxis bevestigt dat een parser de structuur kan lezen, niet dat de geëxtraheerde feiten kloppen.
Leer van het uitgewerkte voorbeeld.
Het downloadbare voorbeeld is een JSON-object. Vergelijk de structuur en omgang met ontbrekende waarden met het resultaat dat je nodig hebt en controleer daarna je eigen waarden met de bron.
Het aangeleverde voorbeeld is ter illustratie. Het is geen vastgelegde uitvoering met jouw gegevens.
Download het voorbeeld ↓Gebruik het met je eigen materiaal.
- Open de bron waarmee je wilt werken en activeer WebAct op dat tabblad.
- Kopieer de taak uit het bovenste blok, voeg vereiste velden of voorkeuren toe en controleer de voorgestelde acties.
- Vergelijk het eerste resultaat met je bron. Vraag waar nodig om een gerichte correctie of verfijning.