swagger-php, имеющий разные документы из одного и того же кода
Мы используем slim framework и swagger-php для динамической генерации документации по swagger.
Теперь у нас есть некоторые специальные методы в API, которые не следует публично документировать. (/ Док сейчас)
Могу ли я получить второй 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);
Замечания: Этот пример показателен и не проверен, вы также можете исключить имена файлов.
Другие решения
Других решений пока нет …