php-symfony.README.mustache Maven / Gradle / Ivy
# {{bundleName}}
{{#appDescriptionWithNewLines}}
{{{.}}}
{{/appDescriptionWithNewLines}}
This [Symfony](https://symfony.com/) bundle is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: {{appVersion}}
{{#artifactVersion}}
- Package version: {{.}}
{{/artifactVersion}}
{{^hideGenerationTimestamp}}
- Build date: {{generatedDate}}
{{/hideGenerationTimestamp}}
- Build package: {{generatorClass}}
{{#infoUrl}}
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
{{/infoUrl}}
## Requirements
PHP 7.1.3 and later
## Installation & Usage
To install the dependencies via [Composer](http://getcomposer.org/), add the following repository to `composer.json` of your Symfony project:
```json
{
"repositories": [{
"type": "path",
"url": "//Path to your generated openapi bundle"
}],
}
```
Then run:
```
composer require {{gitUserId}}/{{gitRepoId}}:dev-master
```
to add the generated openapi bundle as a dependency.
## Tests
To run the unit tests for the generated bundle, first navigate to the directory containing the code, then run the following commands:
```
composer install
./vendor/bin/phpunit
```
## Getting Started
Step 1: Please follow the [installation procedure](#installation--usage) first.
Step 2: Enable the bundle in the kernel:
```php