JSON Schema
Converting JSON schemas to syntax diagrams #201
Replies: 3 comments 5 replies
-
|
I know @awwright is working on mapping JSON Schema definitions to automata. I would presume that getting a syntax diagram out of an automata would be a much simpler transformation. |
Beta Was this translation helpful? Give feedback.
-
|
This ought to be fully possible, and I'm building towards doing exactly this. It just requires a bit of work. Unfortunately there's not very much tooling around ABNF; it seems that developers typically re-implement the ABNF by hand. So I'm building that out. However I'm not sure how comprehensible the diagrams would be. Here is the ABNF representing the set of Most JSON schema keywords can be expressed as grammar like this. It's just a matter of how complicated it is. For the curious: multipleOf is one of these compatible keywords because of two things. First, you can append a In short, I think JSON Schema is the human-friendly format — and ABNF (or regular expression) is the way of describing how a computer would parse a JSON document meeting those specifications. Thanks for the ping @jviotti |
Beta Was this translation helpful? Give feedback.
-
|
@Markus-Elfring Can you tell me a little bit more about what you're looking to do? |
Beta Was this translation helpful? Give feedback.
-
|
I am developing JSON schema files for some use cases. |
Beta Was this translation helpful? Give feedback.
-
|
Are these users implementing their own parser? Usually it's much easier to use an existing parser, unless you're doing something really fancy. |
Beta Was this translation helpful? Give feedback.
-
|
💭 Syntax diagrams should generally help with the communication and understanding for various data formats, shouldn't they? Special software components will usually be constructed for customised (JSON) data structures also with the help of parser generators, won't they? 🤔 |
Beta Was this translation helpful? Give feedback.
-
|
I was also looking for a tool that transforms a given JSON-schema into syntax diagrams. I have since come across some libraries that can transform subsets of JSON-schemas into a constrained form of BNFs (GBNF) [1]. [1]: |
Beta Was this translation helpful? Give feedback.
-
|
I think the conclusion by @awwright, that JSON-schema is the human-readable format, may be correct. Take the following extremely simple JSON-schema: {
"properties": {
"simpleString": {
"type": "string"
}
}
}which yields the following GNBF (using JSON-Schema-to-GBNF): root-simpleString ::= "\"simpleString\"" ":" ws01 string
root ::= undefined ws01
value ::= (object | array | string | number | boolean | null) ws
object ::=
"{" ws (
string ":" ws value
("," ws string ":" ws value)*
)? "}"
array ::=
"[" ws01 (
value
("," ws01 value)*
)? "]"
string ::=
"\"" (string-char)* "\""
string-char ::= [^"\\] | "\\" (["\\/bfnrt] | "u" [0-9a-fA-F] [0-9a-fA-F] [0-9a-fA-F] [0-9a-fA-F]) # escapes
number ::= integer ("." [0-9]+)? ([eE] [-+]? [0-9]+)?
integer ::= "-"? ([0-9] | [1-9] [0-9]*)
boolean ::= "true" | "false"
null ::= "null"
# Optional space: by convention, applied in this grammar after literal chars when allowed
ws ::= ([ \t\n] ws)?
ws01 ::= ([ \t\n])?which requires some corrections to get the W3C EBNF notation root ::= "{" ws01 root-simpleString "}"
root-simpleString ::= "\"simpleString"\"
value ::= (object | array | string | number | boolean | null)
object ::=
"{" ws (
string ":" ws value
("," ws string ":" ws value)*
)? "}"
array ::=
"[" ws01 (
value
("," ws01 value)*
)? "]"
string ::= "\" (string-char)* "\"
string-char ::= [^"\\] | "\\" (["\\/bfnrt] | "u" [0-9a-fA-F] [0-9a-fA-F] [0-9a-fA-F] [0-9a-fA-F])
number ::= integer ("." [0-9]+)? ([eE] [-+]? [0-9]+)?
integer ::= "-"? ([0-9] | [1-9] [0-9]*)
boolean ::= "true" | "false"
null ::= "null"
ws ::= ([ \t\n] ws)?
ws01 ::= ([ \t\n])?and finally produces this railroad diagram (using Railroad Diagram Generator): For my purposes (mostly documentation of DSL's that are derived from Typescript types), one of the following seems more appropriate:
|
Beta Was this translation helpful? Give feedback.
-
💭 I would like to convert selected JSON schemas to syntax diagrams.
Which tools can help any more with corresponding data visualisations? 🤔
Beta Was this translation helpful? Give feedback.
All reactions