Skip to content

Commit

Permalink
Merge pull request #8 from skoro/2-openapi-integration
Browse files Browse the repository at this point in the history
OpenAPI integration
  • Loading branch information
skoro authored Aug 27, 2024
2 parents 557d913 + 993b2ee commit f1e1c13
Show file tree
Hide file tree
Showing 14 changed files with 922 additions and 19 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,9 @@ _TBD: make docker installation_
symfony serve -d
```

## API documentation
Two end-points are available for getting the API documentation:
- `/api/doc` swagger ui.
- `/api/doc.json`
as above but in Json format
for consuming by [Postman](https://www.postman.com/product/what-is-postman/), for example.
7 changes: 6 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,10 @@
"doctrine/doctrine-migrations-bundle": "^3.3",
"doctrine/orm": "^3.2",
"moneyphp/money": "^4.5",
"nelmio/api-doc-bundle": "^4.29",
"phpdocumentor/reflection-docblock": "^5.4",
"phpstan/phpdoc-parser": "^1.29",
"symfony/asset": "6.4.*",
"symfony/console": "6.4.*",
"symfony/doctrine-messenger": "6.4.*",
"symfony/dotenv": "6.4.*",
Expand All @@ -25,9 +27,12 @@
"symfony/property-info": "6.4.*",
"symfony/runtime": "6.4.*",
"symfony/serializer": "6.4.*",
"symfony/twig-bundle": "6.4.*",
"symfony/uid": "6.4.*",
"symfony/validator": "6.4.*",
"symfony/yaml": "6.4.*"
"symfony/yaml": "6.4.*",
"twig/extra-bundle": "^2.12|^3.0",
"twig/twig": "^2.12|^3.0"
},
"config": {
"allow-plugins": {
Expand Down
Loading

0 comments on commit f1e1c13

Please sign in to comment.