diff --git a/README.md b/README.md index 37c0e4f..0328408 100644 --- a/README.md +++ b/README.md @@ -61,9 +61,26 @@ docker exec ogcore-php php bin/console doctrine:migrations:migrate --no-interact ```sh docker exec ogcore-php php bin/console doctrine:fixtures:load --no-interaction docker exec ogcore-php php bin/console app:load-default-user-groups - ``` +## UX Api Platform + +Api Platform proporciona una interfaz de usuario para interactuar con la API de ogCore. Para acceder a la interfaz de usuario, accede a la siguiente URL: + +```sh +http://127.0.0.1:8080/api/docs +``` + +Para poder autenticarte, necesitas un token JWT. Para obtenerlo, accedemos al endpoint de autenticación "auth/login": + +![img.png](swagger-assets/img.png) +![img.png](swagger-assets/img2.png) +Obtenemos el token y lo introducimos en la interfaz de usuario de Api Platform de la siguiente manera: + +![img.png](swagger-assets/img3.png) + +Ahora, ya podemos interactuar con la API de ogCore. Para comprobar que todo está correcto, podemos fijarnos en los headers de las llamadas Curl, y ver que el token JWT se ha introducido correctamente. + ## Test Para ejecutar los test, ejecutamos el siguiente comando: @@ -71,3 +88,12 @@ Para ejecutar los test, ejecutamos el siguiente comando: ```sh docker compose exec php bin/phpunit ``` + +## Reiniciar base de datos + +Es posible que en momentos de desarrollo, sea necesario volver a cargar la base de datos y actualizar los esquemas de la misma, para ello, ejecutamos el siguiente comando: + +```sh +docker exec ogcore-php php bin/console doctrine:database:drop --force +docker exec ogcore-php php bin/console doctrine:database:create +``` diff --git a/swagger-assets/img.png b/swagger-assets/img.png new file mode 100644 index 0000000..6673bfc Binary files /dev/null and b/swagger-assets/img.png differ diff --git a/swagger-assets/img2.png b/swagger-assets/img2.png new file mode 100644 index 0000000..fa4241c Binary files /dev/null and b/swagger-assets/img2.png differ diff --git a/swagger-assets/img3.png b/swagger-assets/img3.png new file mode 100644 index 0000000..4ea8d9a Binary files /dev/null and b/swagger-assets/img3.png differ