noma-solutions / api-doc-bundle

NelmioApiDoc的增强版，可以从注释生成REST API的文档

维护者

详细信息

github.com/noma-solutions/NelmioApiDocBundle

安装数: 9,715

类型:symfony-bundle

v4.1.0 2020-12-10 22:00 UTC

Requires

php: >=7.1.3
ext-json: *
phpdocumentor/reflection-docblock: ^3.1|^4.4|^5.0
symfony/framework-bundle: ^4.4|^5.0
symfony/options-resolver: ^4.4|^5.0
symfony/property-info: ^4.4|^5.0
zircote/swagger-php: ^3.0

Requires (Dev)

api-platform/core: ^2.4
doctrine/annotations: ^1.11
doctrine/common: ^2.4
friendsofsymfony/rest-bundle: ^2.8|^3.0@dev
jms/serializer: ^1.14|^3.0
jms/serializer-bundle: ^2.3|^3.0
sensio/framework-extra-bundle: ^4.4|^5.0
symfony/asset: ^4.4|^5.0
symfony/browser-kit: ^4.4|^5.0
symfony/cache: ^4.4|^5.0
symfony/config: ^4.4|^5.0
symfony/console: ^4.4|^5.0
symfony/dom-crawler: ^4.4|^5.0
symfony/form: ^4.4|^5.0
symfony/phpunit-bridge: ^5.2
symfony/property-access: ^4.4|^5.0
symfony/routing: ^4.4|^5.0
symfony/stopwatch: ^4.4|^5.0
symfony/templating: ^4.4|^5.0
symfony/twig-bundle: ^4.4|^5.0
symfony/validator: ^4.4|^5.0
willdurand/hateoas-bundle: ^1.0|^2.0

Suggests

api-platform/core: For using an API oriented framework.
friendsofsymfony/rest-bundle: For using the parameters annotations.

Provides

None

Conflicts

symfony/framework-bundle: 4.2.7

Replaces

None

MIT a9e8db4af0522588c40b0f52992995efc7beaa62

documentation rest api doc

This package is auto-updated.

Last update: 2024-09-29 02:02:29 UTC

README

关于我们的分支

免责声明：这是一个为nelmio/NelmioApiDocBundle创建的分支，用于我们的内部使用。

首先，我们需要改变模型注册背后的机制，以便JMS模型哈希不是基于组和FQCN创建，而是基于字段列表。

让我们看看我们是否能够做到这一点：）

简介

NelmioApiDocBundle组件允许您为API生成良好的文档。

从2.x迁移到3.0

要从2.x迁移到3.0，请按照我们的指南进行。

安装

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

composer require nelmio/api-doc-bundle

文档

在symfony.com上阅读文档

贡献

查看CONTRIBUTING文件。

运行测试

安装Composer依赖项

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

然后运行测试套件

./phpunit

许可证

此组件在MIT许可证下发布。