Answer the question
In order to leave comments, you need to log in
What are the ways to document JSON/XML structures?
Please tell me a convenient way that allows you to maintain documentation on the xml / json contract, namely
- view / edit the hierarchical structure in the form of a tree
- indicate the value type of each node
- enter documentation for each node; node description can take several paragraphs
. What practices do you use? What can you advise?
Answer the question
In order to leave comments, you need to log in
If you focus on the tag ajax
, then you can assume that we are talking about API responses. The same OpenAPI allows you to describe, among other things, the structure of json responses.
For XML, there has been XML Schema for a long time, for JSON they made an analogue - JSON Schema.
Didn't find what you were looking for?
Ask your questionAsk a Question
731 491 924 answers to any question