2015-02-05 2 views
6

У меня есть REST веб-сервиса с использованием CodeIgniter и с помощью этой библиотеки: https://github.com/chriskacerguis/codeigniter-restserverСоздание REST документации в проекте CodeIgniter

Я хочу, чтобы создать документацию для этой веб-службы. Я хочу использовать пользовательский интерфейс Swagger для создания этой документации. Но я не нашел никакой документации, как использовать Swagger с Codeigniter.

Единственный проект, используя эти две технологии, это один, но не имеют хорошую документацию: https://github.com/panxp/codeigniter-swagger

Может кто-то вставить пример использования этого две технологии или дать мне ссылку на хорошую документацию? Конечно, если есть еще одна хорошая библиотека для создания документации, я возьму ее, если она будет использоваться с Codeigniter.

ответ

2

В прошлых проектах я использовал http://apidocjs.com/, которые я нахожу довольно простыми в использовании и понятными для создания из нескольких сред. Мне потребовалось 15-20 минут, чтобы разобраться и посмотреть, как я хотел, чтобы у него была установлена ​​npm. Это не очень заботит каталог или структуру кода, просто предоставленная вами информация в блоках doc.