2010-11-18 7 views
0

Я создал свой REST API, и теперь мне нужно написать документацию для API.Создайте DOC для API REST

Поскольку API в основном генерируется сторонним плагином, невозможно автоматически создать DOC.

Какой лучший инструмент (сэкономить время) на вручную написать DOC?

PS: У меня есть учетная запись github, интересно, могут ли страницы пользователя соответствовать этой потребности.

ответ

0

Вы можете провел некоторое время, чтобы положить DocBlock во все функции/класса вы построили

Инструмент как PHPDOC доступен для компилировать DocBlock в документации и регенерировать все, что нужно (в нужный формат).

Не говоря уже, хранится в виде статических HTML

+0

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

+0

Чувак, читайте описание php http://www.phpdoc.org/ – ajreal

+0

Можете ли вы дать мне пример URL-адреса, чтобы оправдать время, которое вы предлагаете потратить на чтение всей документации? –