We are using slim framework and swagger-php to dynamically generate the swagger documentation. We now have some special methods in the API that should not be publicly documentated. (/doc now) Is there any way I can have a second documentation url (/doc2) where I can get the secret methods and params documentated? (without having to make the documentation by hand, just using the annotations in the php code). Thanks.
1条回答 默认 最新
- douting0585 2016-02-08 15:04关注
As per the latest version of swagger-php you can indicate a list of files and/or directories to exclude from scanning when building the documentation.
See the scan function's docblock on github for details.
A solution to your problem is to separate the public and private methods into different files. Then create two documentation generation methods/functions each excluding the other's files.
Example:
$privateOptions = array( 'exclude' => array('app/api/public') ); $privateDoc = Swagger\scan("app/", $privateOptions); ... $publicOptions = array( 'exclude' => array('app/api/private') ); $publicDoc = Swagger\scan("app/", $publicOptions);
Note: This example is indicative and not tested, you can also exclude filenames.
本回答被题主选为最佳回答 , 对您是否有帮助呢?解决 无用评论 打赏 举报
悬赏问题
- ¥15 微信公众号自制会员卡没有收款渠道啊
- ¥15 stable diffusion
- ¥100 Jenkins自动化部署—悬赏100元
- ¥15 关于#python#的问题:求帮写python代码
- ¥20 MATLAB画图图形出现上下震荡的线条
- ¥15 关于#windows#的问题:怎么用WIN 11系统的电脑 克隆WIN NT3.51-4.0系统的硬盘
- ¥15 perl MISA分析p3_in脚本出错
- ¥15 k8s部署jupyterlab,jupyterlab保存不了文件
- ¥15 ubuntu虚拟机打包apk错误
- ¥199 rust编程架构设计的方案 有偿