structure du projet

Voici l’arborescence du projet que vous avez téléchargé (outre les fichiers spécifiques JS):

dossier
├── src                             <-- votre code dans n'importe quel langage
├── README.md                       <-- les indications de comment executer le projet
├── RESPONSE.md
├── doc.md / doc.yml
├── Dockerfile

doc.md / doc.yml

Le fichier doc devra réprésenter la documentation de votre API il devra contenir tous les endpoints, les erreurs, les objets en entrée / sortie.

Vous pouvez :

  • soit utiliser openAPI3 (avec le site swagger editor pour vous aider), vous n’aurez plus qu’à copier / coller le résultat dans ce fichier.

  • soit utiliser une librairie externe qui l’auto-génère

  • soit faire un simple fichier texte ou markdown qui décris les données ci-dessus, voici un exemple :

      URL: http://localhost:3002/api/book
  VERBE: GET
  ENTREE PARAMS:
      - limit: int
      - index: int
  -------
  URL: http://localhost:3002/api/book/{id}
  VERBE: GET
  -------
  URL: http://localhost:3002/api/book
  VERBE: POST
  ENTREE BODY: { title: string!, description? }
  -------
  URL: http://localhost:3002/api/admin
  VERBE: GET
  HEADERS:
      - Authorization: Bearer <token>

! = required ? = optional