Существуют ли какие-либо механизмы CMS, предназначенные для создания справочной документации по REST API?
Я нахожусь в процессе создания REST API для взаимодействия с новым сайтом SaaS, который мы создаем, и нам нужно документировать API для использования сторонним разработчиком iOS (и другими разработчиками, как только сервис станет общедоступным). Существуют ли какие-либо системы управления контентом, управляемые базой данных, которые облегчают создание документации API для этого типа системы?
Я надеюсь на что-то более индивидуальное, чем может дать универсальная вики или WordPress сборка.
редактировать: я, вероятно, должен упомянуть, что наш VPS настроен как стек LAMP, поэтому что-то управляемое PHP было бы предпочтительнее.
Самодокументирование не является обязательным требованием, на самом деле я хочу что-то более ручное. Я хотел бы использовать CMS в качестве платформы для разработки API, которые также должны быть написаны.
2 ответа
I/O Docs - это интерактивная система документации, работающая на nodejs. Вы генерируете JSON-схему своего API, и она предоставляет сайт HTML/JS, который описывает ваш API и позволяет разработчикам играть с ним в реальном времени из своего браузера.
Swagger - это спецификация для генерации документации по API и платформа для запуска вашего собственного сайта документации.
Хотя Apigee ToGo не заменяет документацию, он станет отличным дополнением к более общей CMS для документов.
Sphinx не ориентирован на REST, но будет генерировать документацию в целом.
Если вы создаете свой API в Java, то на Enunciate тоже есть что посмотреть. Он будет создавать документацию из JavaDocs.
У Swagger есть "ручной" способ ввода ваших спецификаций и создания документации. Смотрите этот ответ здесь: https://stackru.com/a/12085196/411229
Ссылка на пример проекта: https://github.com/wordnik/swagger-core/tree/master/samples/no-server