Merge pull request #19 from amvid/feature/openapi-support

Draft: feature: openapi spec support and swagger ui

.env

@@ -1,7 +1,8 @@
 APP_ENV=dev
 APP_SECRET=26d0c51cd74d7f0e55a6f170988c6cb9
+APP_NUM_WORKERS=1
 
 API_AUTH_TOKEN=qwerty
-API_AUTH_ENABLED=false
+API_AUTH_ENABLED=true
 
 DATABASE_URL="mysql://geo-service:qwerty@geo-service-db:3306/geo-service?serverVersion=10.9.3-MariaDB&charset=utf8mb4"

.rr.dev.yaml

@@ -4,17 +4,17 @@ server:
   command: "php public/index.php"
   env:
     - APP_RUNTIME: Baldinof\RoadRunnerBundle\Runtime\Runtime
+    - XDEBUG_SESSION: 1
 
 http:
   address: 0.0.0.0:8080
   middleware: [ "static", "gzip" ]
   pool:
+    num_workers: ${APP_NUM_WORKERS:-1}
     debug: true
-  uploads:
-    forbid: [ ".php", ".exe", ".bat" ]
   static:
     dir: "public"
-    forbid: [ ".php", ".htaccess" ]
+    forbid: [ ".php" ]
 
 logs:
   mode: development
@@ -24,5 +24,3 @@ logs:
     server:
       level: info # Everything written to worker stderr is logged
       mode: raw
-    metrics:
-      level: debug

.rr.yaml

@@ -9,12 +9,11 @@ http:
   address: 0.0.0.0:8080
   pool:
     debug: false
+    num_workers: ${APP_NUM_WORKERS:-1}
   middleware: [ "static", "gzip" ]
-  uploads:
-    forbid: [ ".php", ".exe", ".bat" ]
   static:
     dir: "public"
-    forbid: [ ".php", ".htaccess" ]
+    forbid: [ ".php" ]
 
 logs:
   mode: production

Makefile

@@ -26,6 +26,12 @@ migration:
 migrate:
 	@docker exec geo-service-app-dev sh -c "php bin/console d:m:m"
 
+openapi:
+	@docker exec -it geo-service-app-dev sh -c "bin/console nelmio:apidoc:dump --format=yaml > openapi.yaml"
+
+cache:
+	@docker exec geo-service-app-dev sh -c "bin/console cache:clear"
+
 .PHONY: user
 user:
 	@docker exec -it geo-service-app-dev php bin/console app:create-user

README.md

@@ -8,12 +8,20 @@ Geo data REST API service with admin dashboard to manage regions, countries, nat
 [PHP8.3](https://www.php.net/releases/8.3/en.php) |
 [Symfony 6](https://symfony.com) |
 [EasyAdminBundle](https://symfony.com/bundles/EasyAdminBundle/current/index.html)
+[OpenAPI](https://swagger.io/specification/)
 
 ### Admin Dashboard
 
 ![Screenshot](docs/img/country_dark.png)
 ![Screenshot](docs/img/airport_light.png)
 
+### Swagger UI
+
+```text
+https://127.0.0.1:8085/apidoc
+
+```
+
 ### Installation
 
 ```bash
@@ -38,6 +46,14 @@ make user
 make test
 ```
 
+### OpenAPI
+
+Regenerate openapi.yaml in project root directory
+
+```bash
+make openapi
+```
+
 ### Import
 
 All geo data

composer.json

@@ -11,6 +11,7 @@
     "doctrine/doctrine-migrations-bundle": "^3.3",
     "easycorp/easyadmin-bundle": "^4.9",
     "halaxa/json-machine": "^1.1",
+    "nelmio/api-doc-bundle": "^4.24",
     "ramsey/uuid": "^4.7",
     "ramsey/uuid-doctrine": "^2.0",
     "symfony/browser-kit": "6.4.*",