NelmioApiDocBundle

NelmioApiDocBundle

NelmioApiDocBundle捆绑包允许您为 API 生成合适的文档。

从 3.x 迁移到 4.0

要从 3.x 迁移到 4.0，请遵循我们的指南。

4.0 版本带来了 OpenAPI 3.0 支持。如果您想坚持使用 Swagger 2.0，则应该使用此捆绑包的版本 3。

从 2.x 迁移到 3.0

要从 2.x 迁移到 3.0，请遵循我们的指南。

安装

打开命令控制台，进入您的项目目录并执行以下命令以下载此捆绑包的最新版本：

composer require nelmio/api-doc-bundle

文档

阅读 symfony.com 上的文档

贡献

请参阅贡献文件。

运行测试

安装 Composer 依赖项：

git clone https://github.com/nelmio/NelmioApiDocBundle.git
cd NelmioApiDocBundle
composer update

然后运行测试套件：

./phpunit

执照

该捆绑包是根据 MIT 许可证发布的。