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 2020长安杯与连接网探
- ¥15 关于#matlab#的问题:在模糊控制器中选出线路信息,在simulink中根据线路信息生成速度时间目标曲线(初速度为20m/s,15秒后减为0的速度时间图像)我想问线路信息是什么
- ¥15 banner广告展示设置多少时间不怎么会消耗用户价值
- ¥16 mybatis的代理对象无法通过@Autowired装填
- ¥15 可见光定位matlab仿真
- ¥15 arduino 四自由度机械臂
- ¥15 wordpress 产品图片 GIF 没法显示
- ¥15 求三国群英传pl国战时间的修改方法
- ¥15 matlab代码代写,需写出详细代码,代价私
- ¥15 ROS系统搭建请教(跨境电商用途)