Just look at Doctrine ORM API.
- PHP 5.4
-
Download ApiGen
-
Run ApiGen with source and destination options:
php apigen.phar generate -s src -d ../my-project-api
To omit cli options just create apigen.yaml
or apigen.neon
file in your project.
source:
- src
destination: ../my-project-api
For global installation, see documentation.
composer require apigen/apigen --dev
Then run with options as above:
php vendor/bin/apigen generate -s src -d ../my/project-api
To see all available options with its description and default values, just run:
apigen generate --help
Note: in apigen.neon
is prefered camel case (accessLevel
) over dash-case in CLI (--access-level
).
If you want to know what annotations do we support, here is the list.
$ phpunit
Please see CONTRIBUTING for details.