Автоматическое документирование REST API в PHP

phpDocumentor кажется стандартом для документирования кода PHP, хотя я должен задаться вопросом, почему он не обновлялся годами?

Однако, он не подходит для документирования точек входа для REST API; IE, доступные извне точки входа, которые могут быть интересны конечному пользователю вашей системы, в отличие от документирования всех внутренних классов и т. Д. - что-то интересное только для разработчиков api.

Я ищу то, где я можно сказать, что этот метод доступен извне через REST по этому URL-адресу, вот аргументы GET или POST, которые он принимает, он поддерживает методы HTTP GET / POST / и т. д., он возвращает JSON или XML или что-то еще.

Эта информация будет может создать документ API. Его также можно использовать внутри кода для автоматической фильтрации входных данных, проверки выходных данных, создания базовых модульных тестов и т. Д.

22
задан Greywire 15 March 2011 в 17:24
поделиться