Lzh on GitHub

Swagger-PHP 是什么

swagger-php 是一个从你的 PHP 源代码文件中提取 API 元数据的库。

swagger-php 是一个从你的 PHP 源代码文件中提取 API 元数据的库。

它的理念是,在你的应用程序中,将 swagger-php 注解属性 添加到相关的 PHP 代码旁边。这些注解/属性将包含你的 API 详情,而 swagger-php 会将它们转换成机器可读的 OpenAPI 文档

通过将 API 文档添加到相应的源代码旁边(在同一个文件中!),所有细节都可以在一个地方修改,从而很容易保持文档的实时更新。

注解与属性
当我们谈论对代码进行 “注解”(annotating)时,我们指的是向你的代码库中添加元数据的行为。这可以通过添加AnnotationsAttributes来实现。
要求
使用 swagger-php 需要最低 PHP 7.4 版本来使用注解(annotations),或最低 PHP 8.1 版本来使用属性(attributes)。