Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
Zrnik committed Mar 18, 2024
1 parent ea1bff3 commit b584a31
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,4 +87,18 @@ $zweistRouteService = new ZweistRouteService($zweistConfiguration);
$zweistRouteService->applyRoutes($app);
```

## More things you should know

You will need to create a class with `openapi`
description attributes.
(see [./tests/ExampleApplication/ExampleApplicationInfo.php](./tests/ExampleApplication/ExampleApplicationInfo.php))

You want to **generate** `openapi.json` and `router.json` locally when developing,
and then committing them with your code, because you do not want to scan all the files
for the router at runtime for every request.

You should check on the CI that you didn't forget to generate new files.

Classes `ZweistOpenApiGenerator`, `ZweistRouteService` and `ZweistConfiguration`
should be configured to be delivered by DI container.

0 comments on commit b584a31

Please sign in to comment.