Question

我们正在使用slim framework和swagger-php动态生成swagger文档。我们现在在API中有一些不应公开记录的特殊方法。（/ doc now）有没有办法我可以有第二个文档URL（/ doc2），我可以获取秘密方法和params文件？（无需手动编写文档，只需使用php代码中的注释）。感谢。

Answer 1

根据最新版本的swagger-php，您可以指明在构建文档时要从扫描中排除的文件和/或目录列表。

有关详细信息，请参阅github上的扫描功能docblock。

您的问题的解决方案是将公共和私有方法分成不同的文件。然后创建两个文档生成方法/函数，每个方法/函数排除其他文件。

<强> 实施例

$privateOptions = array(
    'exclude' => array('app/api/public')
);
$privateDoc = Swagger\scan("app/", $privateOptions);
...
$publicOptions = array(
    'exclude' => array('app/api/private')
);
$publicDoc = Swagger\scan("app/", $publicOptions);

注意：此示例是指示性的，未经过测试，您也可以排除文件名。

swagger-php具有来自相同代码

1 个答案: