refs #380. Modify Readme.md

pull/5/head
Manuel Aranda Rosales 2024-05-29 12:07:09 +02:00
parent 2a2c2bcfe0
commit 82ea76a557
4 changed files with 27 additions and 1 deletions

View File

@ -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
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 119 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 130 KiB