elao / api-resources-metadata
Extract API resource objects' metadata using different providers
Installs: 1 659
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 5
Forks: 0
Open Issues: 1
Requires
- php: >=7.0
Requires (Dev)
- doctrine/annotations: ^1.3
- friendsofphp/php-cs-fixer: ^2.0
- nelmio/api-doc-bundle: ^2.13
- phpdocumentor/reflection-docblock: ^3.0|^4.0
- phpunit/phpunit: ^5.6
- psr/cache: ^1.0
- symfony/cache: ^3.1
- symfony/framework-bundle: ^3.1
- symfony/phpunit-bridge: ^3.1
- symfony/property-info: ^3.1
- symfony/templating: ^3.1
- symfony/var-dumper: ^3.1
- symfony/yaml: ^3.1
Suggests
- nelmio/api-doc-bundle: To document your API using the NelmioApiDoc bundle integration
- psr/cache-implementation: To cache resources and metadata
- symfony/property-info: To use the PropertyInfoLoader
- symfony/yaml: To use the YamlFileLoader
Conflicts
- phpdocumentor/reflection-docblock: <3.0||>=3.2.0,<3.2.2
This package is auto-updated.
Last update: 2021-01-05 11:43:56 UTC
README
This library allows to extract common API information from resource objects in dedicated metadata.
Those metadata can then be used to help generating documentation, data transformers/normalizers, ...
Many integrations could be provided. For instance, a generic Nelmio API Doc parser using generated api resources metadata to document API inputs & outputs.