swagger-php具有来自同一代码的不同文档 - swagger-php having different documentations from the same code

swagger-php having different documentations from the same code

本文关键字：代码文档 swagger-php | 更新日期: 2023-09-27

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

根据最新版本的 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);

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