Kruse-Net.dk

Det man blogger er man selv…

JSON Schema

I mit arbejde får jeg i stigende grad behov for at web services kommunikerer i JSON formatet, foruden eller i stedet for XML. Det har skabt et tilsvarende behov for at kunne dokumentere disse formater, både med henblik på at andre udviklere kunne få besvaret deres spørgsmål, og med henblik på mulig maskinel validering af kommunikationen.

I et forsøg på at opfylde dette behov har jeg kigget mig omkring. Det var et krav (fra mig) at tingene skulle kunne dokumenteres i JSON — primært for ikke at forvirre folk yderligere med endnu et nyt format. I første omgang faldt jeg over en løsning Thomas Messier har lavet til brug i ColdFusion. Strukturen var tillokkende, men desværre virker arbejdet noget ufærdigt. I min videre søgen er jeg kun faldet over Kris Zyp’s JSON Schema Proposal. Den er noget mere gennemarbejdet og detaljeret, men indeholder til gengæld en række meget alvorlige brister som gør at den er ubrugelig i sin nuværende form.

Da mit dokumentations-behov er ret presserende var der intet andet at gøre — jeg måtte tage del i arbejdet, og komme med mit eget oplæg. Jeg håber at folk finder det brugbart. Kommentarer er som sædvanlig meget velkomne. Klik videre til min egen JSON Schema Proposal (siden er på engelsk med tanke på videre internationalt samarbejde).

Skriv et svar