https://github.com/studoo-app/mock-ecole-directe-api
Mock for Testing API Ecole Directe
https://github.com/studoo-app/mock-ecole-directe-api
Last synced: 8 months ago
JSON representation
Mock for Testing API Ecole Directe
- Host: GitHub
- URL: https://github.com/studoo-app/mock-ecole-directe-api
- Owner: studoo-app
- Created: 2023-04-13T10:06:32.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-25T08:25:01.000Z (over 2 years ago)
- Last Synced: 2023-10-25T09:53:41.031Z (over 2 years ago)
- Language: PHP
- Size: 129 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mock Ecole Directe API PHP
Création du mock de l'API Ecole Directe pour les tests unitaires. \
Celui-ci est basé sur le projet [studoo/ecole-directe-api](https://github.com/studoo-app/ecole-directe-api)
## Installation d'image Docker
Ce rendre sur la page des [docker/bfoujols/mock-api-ecole-directe](https://hub.docker.com/r/bfoujols/mock-api-ecole-directe) et récupérer la dernière version.
```bash
docker pull bfoujols/mock-api-ecole-directe
```
## Démarage de l'image Docker
```bash
docker run --name api-ecole-directe -p 9042:80 -d bfoujols/mock-api-ecole-directe
```
Vous pouvez maintenant accéder à l'API via l'adresse http://localhost:9042 \
Vous pouvez tester l'API via Insomnia :
[](https://insomnia.rest/run/?label=MOCK%20API%20ECOLE%20DIRECTE&uri=https%3A%2F%2Fraw.githubusercontent.com%2Fstudoo-app%2Fmock-ecole-directe-api%2Fmain%2FInsomnia.json)
## Utilisation de l'API Ecole Directe Mock
Ce mock auto-génère des données à travers des fakers :
### API : /dataset/classes
Visualisation des données des classes
### API : /dataset/etudiants
Visualisation des données des étudiants
### API : /dataset/profs
Visualisation des données des profs
### API : /login
Certains users sont configurés dans le fichier de configDataSet
| Login/Password | Role | Niveau | Id Niveau |
|--------------------------|----------------|------------------------------|---------------|
| FPELTIER/test | Etudiante | BTS SIO 1 année A (1TSSIOA) | 107 |
| PTORRE/test | Etudiante | BTS SIO 1 année A (1TSSIOA) | 107 |
| JBOULLAM/test | Etudiant | Bachelor CSI | 140 |
### API : /classes
| Login/Password | Role | Id Classe |
|--------------------------|----------------|---------------------|
| JBOUVIER/test | Prof | 107,120,134,140,141 |
| BDAN/test | Prof | 107,120 |
## Personnalisation du mock
Voici les étapes à suivre :
### Faire un fichier "docker-compose.yml"
La variable "container_name" doit être changé afin d'éviter tout conflit.
La variable "ports" est le port (9042) accessible depuis l'extérieur de Docker. Celui-ci peut être personnalisé, néanmoins le port interne est 80 (apache).
Le volume sert à rendre accessible dans votre projet les fichiers de configuration et la base de données SQLite.
```yaml
version: "3"
services:
api:
container_name: mock-api-ecole-directe
image: bfoujols/mock-api-ecole-directe:latest
ports:
- "9042:80"
volumes:
- ./var/dbdataset:/var/www/mock-ecole-directe-api/var
volumes:
dbdata:
```
### Télécharger le fichier de configuration du DataSet
Pour permettre la personnalisation, vous devez télécharger le modèle de configuration via l'URL suivante :
- Création du dossier dbdataset dans le dossier var/
```bash
mkdir var/dbdataset
```
- Téléchargement du fichier de configuration
Pour windows
```bash
wget "https://raw.githubusercontent.com/studoo-app/mock-ecole-directe-api/main/var/configDataset.json" > var/dbdataset/configDataset.json
```
Pour linux et macos
```bash
curl -fsS https://raw.githubusercontent.com/studoo-app/mock-ecole-directe-api/main/var/configDataset.json > var/dbdataset/configDataset.json
```
Ce modèle exemple vous servira à comprendre les différents paramètres pour :
#### Personnaliser l'établissement
Vous pouvez personnaliser votre établissement :
```json
{
"organisation" : {
"nomEtablissement" : "", // Nom de l'etablissement
"codeOgec" : "", // Code de l'établissement
[...]
}
}
```
Exemple :
```json
{
"organisation" : {
"nomEtablissement" : "STUDOO SCHOOL",
"codeOgec" : "0345587-NC",
[...]
}
}
```
#### Ajouter des classes et année de promotion
Dans la section "organisation" puis "V3" (version de APi), vous pouvez personnaliser les classes :
```json
"promo" : "", // Promotion avec le format YYYY-YYYY
```
Exemple :
```json
"promo" : "2023-2024",
```
Dans la section "organisation" puis "V3" (version de APi), vous pouvez personnaliser les classes :
```json
"classes" : {
"" : { // ID unique de la classe
"libelle" : "", // Libellé de la classe
"code" : "" // Code de la classe
},
```
Exemple :
```json
{
"organisation" : {
[...]
"v3" : {
"promo" : "2023-2024",
"classes" : {
"107" : {
"libelle" : "1 TS SIO A",
"code" : "1TSSIOA"
},
"120" : {
"libelle" : "1 TS SIO B",
"code" : "1TSSIOB"
},
"134" : {
"libelle" : "1 TS SIO - année alternance",
"code" : "1TSSIOALT"
},
```
#### Ajouter des étudiants fixes
L'ensemble des étudiants sont généré par un faker. Pour des soucis de test, vous pouvez figer des étudiants dans le fichier de configuration. Par classe, chaque étudiant peut être présent :
```json
"classes" : {
"" : { // ID unique de la classe
"libelle" : "", // Libellé de la classe
"code" : "" // Code de la classe
."etudiants" : {
"" : { // Position dans le tableau insertion dans la base
"nom": "", // Nom de l'étudiant
"prenom": "", // Prenom de l'étudiant
"email": "", // Email de l'étudiant
"telPortable": "", // Téléphone de l'étudiant
"sexe": "", // Genre de l'étudiant
"login": "", // Login de l'étudiant
"idLogin" : "", // Id interne afin de récuperer l'étudiant en cas de changement majeur
"password": "", // Mot de passe de l'étudiant (Non crypté pour des soucis de test)
"uid": "", // UID de l'étudiant 16bit https://fr.wikipedia.org/wiki/Universally_unique_identifier
"tokenExpiration": "", // La date limite d'expiration du token d'authentification
"lastConnexion": "", // Dernier connexion à l'application
"anneeScolaireCourante": "" // Année de promotion de l'étudiant
},
```
Exemple :
```json
"classes" : {
"107" : {
"libelle" : "1 TS SIO A",
"code" : "1TSSIOA",
"etudiants" : {
"1" : {
"nom": "Peltier",
"prenom": "Flore",
"email": "fp@test.com",
"telPortable": "07 23 45 23 89",
"sexe": "F",
"login": "FPELTIER",
"idLogin" : "7647334",
"password": "test",
"uid": "98432dd9-c483-3669-a31e-153fec2eac72",
"tokenExpiration": "2023-10-08 10:10:03",
"lastConnexion": "2023-10-08 10:10:03",
"anneeScolaireCourante": "2020-2021"
},
```
#### Ajouter des profs
Dans la section "organisation" puis "V3" (version de APi), vous pouvez personnaliser les profs : (Les variables sont équivalentes à la structure d'étudiant)
```json
"professeurs" : {
"": {
"nom": "",
"prenom": "",
"email": "",
"telPortable": "",
"sexe": "",
"login": "",
"idLogin" : "",
"password": "",
"uid": "",
"tokenExpiration": "",
"lastConnexion": "",
"anneeScolaireCourante": "",
"classes" : ""
},
```
Exemple :
```json
"professeurs" : {
"1": {
"nom": "Bouvier",
"prenom": "Julien",
"email": "Julien.Bouvier@test.fr",
"telPortable": "07 11 81 23 83",
"sexe": "M",
"login": "JBOUVIER",
"idLogin" : "34867434",
"password": "test",
"uid": "0f9fdc75-fd68-3fe0-8a09-1864f80025f7",
"tokenExpiration": "2023-10-08 10:10:03",
"lastConnexion": "2023-10-08 10:10:03",
"anneeScolaireCourante": "2020-2021",
"classes" : "107,120,134,140,141"
},
```
### Démarrer les containers Docker
```
docker compose up -d
```
### Générer le DataSet
```
http://localhost:9042/init
```