Мы используем slim framework и swagger–php для динамического создания документации swagger. Теперь у нас есть некоторые специальные методы в API, которые не должны публично оформляться. (/ doc now) Есть ли способ получить второй URL-адрес документации (/ doc2), где я могу получить секретные методы и параметры документально? (без необходимости делать документацию вручную, просто используя аннотации в php-коде). Благодарю.
В соответствии с последней версией swagger-php вы можете указать список файлов и / или каталогов для исключения из сканирования при создании документации.
Подробнее см. В docblock функции проверки на github.
Решение вашей проблемы состоит в том, чтобы разделить общедоступные и частные методы на разные файлы. Затем создайте два метода / функции генерации документации, каждый из которых исключает файлы других.
Пример:
$privateOptions = array( 'exclude' => array('app/api/public') ); $privateDoc = Swagger\scan("app/", $privateOptions); ... $publicOptions = array( 'exclude' => array('app/api/private') ); $publicDoc = Swagger\scan("app/", $publicOptions);
Примечание. Этот пример является ориентировочным и не проверен, вы также можете исключить имена файлов.