Files
symfony-flex-recipes-contrib/jane-php/open-api-common/7.0/post-install.txt
T
Baptiste LeducandGitHub 7101db71f0 Improve JanePHP recipes first-run experience (#2033)
* Improve JanePHP recipes first-run experience

Recipes pointed the generator configs to specification files they never
created, hid all generator output behind a NullOutput (so failures showed
up as raw PHP fatals and successes printed nothing) and always exited 0,
even when generation failed.

- document every config key and the spec file prerequisite in
  config/jane/*.php
- render generator output, format thrown errors and propagate exit codes
  in the recipe bin scripts
- reorder post-install steps: placing the specification file now comes
  before running the generator
- explain when/how to uncomment the generated normalizer service in
  config/packages/jane.yaml

Refs: https://github.com/janephp/janephp/issues/860

* Point recipes to the current documentation website

jane.readthedocs.io is outdated, jane.jolicode.com/latest/ is the
current documentation home.

* Re-trigger QA after adding the license header to the PR description
2026-08-25 11:38:39 +02:00

9 lines
748 B
Plaintext

* <fg=blue>Finish</> package configuration:
1. Place your API specification at <comment>config/jane/open-api.yaml</>, or update <comment>openapi-file</> in <comment>config/jane/open_api.php</>
2. Replace <comment>MyApp\Library\Generated</> with your own namespace in <comment>config/jane/open_api.php</> and in <comment>config/packages/jane.yaml</>
3. Add <comment>generated/</> directory to your composer autoload definition (eg. <comment>"MyApp\\Library\\Generated\\": "generated/"</>)
4. Run <comment>bin/jane-open-api-generate</>
5. Once generation succeeded, uncomment the service in <comment>config/packages/jane.yaml</> to enable autowiring of the generated normalizer
Documentation: https://jane.jolicode.com/latest/