Возможно, вы захотите взглянуть на I / O Docs - систему интерактивной документации с открытым исходным кодом для веб-API RESTful, которую любой владелец API может использовать для развертывания своей собственной документации.Он работает на Node.js и использует Redis в качестве хранилища данных.
https://github.com/mashery/iodocs
Пример: developer.klout.com/iodocs, developer.rottentomatoes.com/iodocs
Он использует файлы на основе схемы JSON для определения конечных точек API, методи параметры.На основе этих файлов JSON создается клиентский интерфейс, который разработчики могут использовать для изучения и изучения вашего API.Вызовы API могут выполняться непосредственно из интерфейса документации, создавая отформатированные ответы.
Это с открытым исходным кодом, так что вы можете быть уверены в регулярных обновлениях и улучшениях.Фактически, в прошедшие выходные Брэндон Уэст из SendGrid (который использует документы ввода-вывода для своей документации) создал и открыл пользовательский интерфейс с открытым исходным кодом для создания / редактирования файлов схемы JSON для документов ввода-вывода.Поэтому вам больше не нужно вручную создавать файлы JSON.
https://github.com/brandonmwest/iodoctor