2023-2024-ECOM-INFO5-G01 / docs

0 stars 0 forks source link

Barème "interface REST en open API avec description" #10

Open aureliencoste opened 9 months ago

aureliencoste commented 9 months ago

Il est indiqué dans le barème, dans la catégorie "Conditions pour pouvoir prétendre avoir au moins 10", avoir une "interface REST en open API avec description".

JHispter nous génère une API REST privée avec une documentation (via Swagger, elle correspond donc au format open API). L'API est complète, pour chaque entité de notre JDL (ehpad, user, patient, rappel, poids, tâche, etc) elle propose une requête POST/GET/PUT/DELETE, ce qui correspond à l'acronyme CRUD (Create, Read, Update, Delete). On a donc la possibilité d'accéder aux données de notre application. Néanmoins, cette API est privée, elle nécessite donc un token pour que n'importe qui puisse faire une requête "sucessful", de plus la documentation est uniquement affichée dans le compte admin et n'est pas accessible à tous.

Ma question est la suivante, pour valider la condition du barème, doit-on créer et gérer un système de token pour permet à n'importe qui de faire des requêtes "sucessful" via l'API + rendre publique la documentation. Ou alors, l'API privée ainsi que la documentation accessible depuis admin est suffisant pour notre application. (Sachant que ce n'est pas le genre d'application avec laquelle on veut partager des données avec d'autres développeurs, ici nos données sont sensibles, on veut laisser le côté privé de l'API, je pense. Si l'API est 100% privée alors la documentation peut le rester aussi, j'imagine.)

SybilleCaffiau commented 9 months ago

Bonjour,

de mon point vue dès lors qu'il existe une API REST de votre application et que vous pouvez indiquer comment des développeurs pourraient l'utiliser, vous répondez aux attentes. Que vous l'ayez totalement/partiellement ou pas du tout développée n'est pas important (savoir utiliser correctement du code généré c'est une compétence à avoir en informatique).