在 PHP 中自动生成 openAPI(swagger) 规范文件

Posted

技术标签:

【中文标题】在 PHP 中自动生成 openAPI(swagger) 规范文件【英文标题】:Generating openAPI(swagger) spec files automatically in PHP 【发布时间】:2021-10-24 10:57:49 【问题描述】:

我想弄清楚如何在我的 php 应用程序中自动生成 openAPI json 或 yaml 文件。到目前为止,我几乎没有看到关于它的文档,所以我对这个问题几乎一无所知。 有什么方法/包/我还缺少什么吗? 我也在使用 laravel 4.2 谢谢。

【问题讨论】:

【参考方案1】:

我推荐这个包:https://github.com/zircote/swagger-php 它从文件中的注释生成 OpenAPI json。我建议您将这些注释放在控制器、模型和中间件中。因此,您将受益于 API 代码中的良好文档。

【讨论】:

以上是关于在 PHP 中自动生成 openAPI(swagger) 规范文件的主要内容,如果未能解决你的问题,请参考以下文章

“内容”是啥意思:在招摇/openapi“响应”中是啥意思:

以编程方式添加安全方案时,模式从组件中消失

swagger-codegen 或 openapi-generator PHP 版本

OpenApi - 有没有办法在使用 springdoc-openapi-maven-plugin 生成的合同中使用带有鉴别器部分的组合模式?

APIM 中的自动更新 OpenAPI 规范

Swagger的学习