php - swagger-php 具有来自相同代码的不同文档

Question

我们正在使用 slim 框架和 swagger-php 来动态生成 swagger 文档。我们现在在 API 中有一些不应该公开记录的特殊方法。(/doc now) 有什么方法可以让我获得第二个文档 url (/doc2)，我可以在其中记录秘密方法和参数？（无需手动制作文档，只需使用 php 代码中的注释即可）。谢谢。

Answer 1

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

有关详细信息，请参阅 github 上的 scan 函数的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);

注意：此示例仅供参考，未经测试，您也可以排除文件名。