Чем документировать API проекта с возможностью поддерживать версии API?

Возникла необходимость описать для сторонних разрабов функциональность API.
Взяли в гуглодоке описали и всем было хорошо, пока API не стал эволюционировать.

Хотелось бы узнать в чем можно вести документирование API с возможностью указывать изменения на каждой ветке
  • Вопрос задан
  • 1004 просмотра
Пригласить эксперта
Ответы на вопрос 1
eduardtibet
@eduardtibet
Technical Writer / Documentation Engineer
Если речь о REST, то можете попробовать связку swagger editor + git + swagger ui ( www.swagger.io ). Если понравится, то:
- там есть codegen
- вся ручная работа перейдет в src
- будет прямо генерить из кода, подобно doxygen.
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы