Выберите инструменты для документов REST API

Question

Я на самом деле использую Doxygen для документирования своего php REST-приложения и просто обнаруживаю, что Apiary & Swagger - хорошие инструменты для документирования API... Я хочу знать, есть ли способ автоматически сгенерировать документацию с помощью одного из этих инструментов (пасеки или чванство) на основании кода комментариев?

Answer 1

С помощью swagger-php вы можете автоматически сгенерировать документацию из набора php-скриптов, задокументированных с использованием аннотаций.

Swagger-PHP хорошо документирован здесь: http://zircote.com/swagger-php/ Рабочий пример можно найти на github: https://github.com/zircote/swagger-php/tree/master/Examples/Petstore

Что касается создания файла JSON, содержащего документацию, проверьте мой ответ здесь: /questions/41174733/swagger-php-api-dokumentatsiya-vyipolnenie-php-fajlov-dlya-sozdaniya-json/41174748#41174748