Как документировать API, общение клиента и сервера?

Question

[Павел]

Есть проблема с документацией запросов клиент-сервер, а именно с тем, что те или иные ключи обозначают.
Так как изменения происходят в проекте чаще, чем ты успеваешь открыть текстовый редактор, встает проблема версионированности REST-запросов клиент-сервер. Постоянно добавляются новые ключи, старые уходят. А через неделю забывается, что к чему.
Начали использовать jsDoc (сервер на NodeJS), но, может есть какая особая штука, которая бы цеплялась к нетворку, сниффала ключи и предлагала описание?

Answer 1

[Илья Ерохин]

raml.org

Answer 2

[vladar]

Вряд ли подойдет для проекта с существующим API, но на будущее может пригодиться - graphql.org (документация автоматическая)

Comments

[flamesoff]

В каком месте там автоматическая документация? )