Grille critériée Backend
Le backend est une appli standalone qui reçoit des ordres en JWT pour sauver les différents élèments.
On doit donc avec des methodes CRUD de la forme :
Method | url | Safe | Idempotent | Valeur de retour | Code retour | commentaire |
---|---|---|---|---|---|---|
GET | /api/v1/<object> |
oui | Oui | {1:object1,2: object2} |
200 | recupère tous les objets |
GET | /api/v1/<object>/id |
oui | Oui | {object1} |
200 ou 404 | recupère un objet |
POST | /api/v1/<object> |
non | non | {object1} |
200 | crée un objet |
PUT | /api/v1/<object>/id |
non | Oui | {object1} |
200 | remplace l'object |
PATCH | /api/v1/<object>/id |
non | non | {object1} |
200 | modifie une partie de l'objet |
DELETE | /api/v1/<object>/id |
non | Oui | aucune | 204 ou 404 | detruit l'objet |
objectX
est la représentation json de l'objet ayabt pour id x
.
À faire pour les objets : rubric
et assessment
Attention
On peut modifier un objet avec ses relations par exemple j'envoie une rubric avec ses criterions
, criteria_group
et descrob
en PUT, et ça remplace tout ce qui est lié (pas très REST ?)
De même le GET renvoi les objet liés pertinents sauf si un paramtre norelated=true
est passé
- Pour rubric
criterion
,criteria_group
etdescrob
- Pour assessment
criterion
,criteria_group
,descrob
,selected_descrob
,assessed_criterion
- Les objets sont triés par leur champ
position
quand ils en ont, sinon parid_truc
Pour JWT voir aussi la lib lcobucci et le middleware JWTServer dans labnbook.
Si le token n'est pas bon retourner erreur 401.
Edited by David Beniamine