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

Question

我们使用slim框架和swagger-php动态生成swagger文档。我们现在在API中有了一些不应该公开记录的特殊方法。(/doc现在)我有什么办法可以获得第二个文档url (/doc2)，在那里我可以将秘密方法和params文档化吗？(无需手工编写文档，只需使用php代码中的注释)。谢谢。

Answer 1

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

有关详细信息，请参阅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);

注意：这个示例是指示性的，没有测试，您也可以排除文件名。