Какие есть способы ведения документации JSON/XML структур?
Подскажите пожалуйста удобный способ, который позволяет вести документацию по xml/json контракту, а именно
- просматривать/редактивровать иерархическую структуру в виде дерева
- указывать тип значения каждого узла
- заносить документацию по каждому узлу; описание узла может занимать несколько абзацев
Какие практики используете? Что можете посоветовать?
Если ориентироваться на тег ajax, то можно предположить, что речь идет об ответах API. Тот же OpenAPI позволяет описать в том числе и структуру json ответов.
В XML проблем с документацией структуры особо нет, а SOAP подразумевает, что это делается один раз на сервер, и все клиенты эту документацию свободно получают в любой момент
ПРо JSON там нет.
Saboteur, я рад за вас что у вас нет проблем с документированием xml. У нас большой документ играет роль в бизнес-логике, поэтому должен иметь описание.
Всё же по поводу SOAP не понятно, что вы хотите предложить? Использовать технологию? Но вопрос-то про документирование структурированных документов. В случае soap - это тоже xml. В части документирования в вашем ответе ничего нет.
