code challenge 10 solution

Author: jschaedl

.env

@@ -26,3 +26,9 @@ DATABASE_URL=sqlite:///%kernel.project_dir%/var/data.db
 # DATABASE_URL="mysql://db_user:db_password@127.0.0.1:3306/db_name?serverVersion=5.7"
 # DATABASE_URL="postgresql://db_user:db_password@127.0.0.1:5432/db_name?serverVersion=13&charset=utf8"
 ###< doctrine/doctrine-bundle ###
+
+###> lexik/jwt-authentication-bundle ###
+JWT_SECRET_KEY=%kernel.project_dir%/config/jwt/private.pem
+JWT_PUBLIC_KEY=%kernel.project_dir%/config/jwt/public.pem
+JWT_PASSPHRASE=959f7ce3e550955002bc425bc1964894
+###< lexik/jwt-authentication-bundle ###

.github/workflows/checks.yml

@@ -28,6 +28,8 @@ jobs:
                       ${{ runner.os }}-php-
             - name: Install Dependencies
               run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+            - name: Generate KeyPair
+              run: php bin/console lexik:jwt:generate-keypair
             - name: cs-check
               run: make cs-check
             - name: tests

.gitignore

@@ -24,3 +24,7 @@
 /phpunit.xml
 .phpunit.result.cache
 ###< phpunit/phpunit ###
+
+###> lexik/jwt-authentication-bundle ###
+/config/jwt/*.pem
+###< lexik/jwt-authentication-bundle ###

CODING-CHALLENGE-11.md

@@ -0,0 +1,31 @@
+# RESTful Webservices in Symfony
+
+## Coding Challenge 11 - API Documentation
+
+### Tasks
+
+Let's document our API using the Nelmio API doc bundle.
+
+### Solution
+
+- require Nelmio's ApiDocBundle: `composer req nelmio/api-doc-bundle`
+- adjust the bundle's configuration:
+
+```yaml
+nelmio_api_doc:
+    documentation:
+        info:
+            title: RESTful Webservices in Symfony
+            description: "SymfonyWorld Online Winter Edition Workshop: RESTful Webservices in Symfony!"
+            version: 1.0.0
+    areas:
+        path_patterns:
+            - ^/api(?!/doc$) # Accepts routes under /api except /api/doc
+            - ^/workshops
+            - ^/attendees
+```
+
+- add some annotation to your controllers, check https://github.com/zircote/swagger-php/tree/master/Examples for examples
+- to be able to see the api documentation website, you need to install Twig and the Asset component:
+  `composer require twig asset` and adjust the routing configuration for the `nelmio/api-doc-bundle` in
+  `config/routes/nelmio_api_doc.yaml`

composer.json

@@ -12,6 +12,7 @@
         "doctrine/doctrine-bundle": "^2.5",
         "doctrine/doctrine-migrations-bundle": "^3.2",
         "doctrine/orm": "^2.10",
+        "lexik/jwt-authentication-bundle": "^2.14",
         "phpdocumentor/reflection-docblock": "^5.3",
         "ramsey/uuid": "^4.2",
         "ramsey/uuid-doctrine": "^1.8",
@@ -26,6 +27,7 @@
         "symfony/property-info": "5.4.*",
         "symfony/proxy-manager-bridge": "5.4.*",
         "symfony/runtime": "5.4.*",
+        "symfony/security-bundle": "5.4.*",
         "symfony/serializer": "5.4.*",
         "symfony/string": "5.4.*",
         "symfony/validator": "5.4.*",