sundowndev
/
express-api-example
mirror of https://github.com/sundowndev/express-api-example.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

master
Raphael Cerveaux 2018-11-12 18:20:48 +01:00 committed by GitHub
parent 8fcbae1a3d
commit a38c0cc6fb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -15,6 +15,7 @@ RESTful API based on Expressjs.
- User: firstname, lastname, email, password - User: firstname, lastname, email, password
- Note: title, text, author - Note: title, text, author
- Auth: jwt_token, expiration_date
## Specs ## Specs
@ -32,6 +33,9 @@ RESTful API based on Expressjs.
- PUT /user/me (si tu vois password et new password, ou mets une autre route si tu veux) (200 ok avec le user après édition mais sans mot de passe bien sûr) - PUT /user/me (si tu vois password et new password, ou mets une autre route si tu veux) (200 ok avec le user après édition mais sans mot de passe bien sûr)
- DELETE /users/me (supprimer le profil) (204 no content, car le user est supprimé et tu ne me renvoi rien) - DELETE /users/me (supprimer le profil) (204 no content, car le user est supprimé et tu ne me renvoi rien)
- GET /users/me (renvoi le user) (200 ok avec en body le user) pouvoir gérer les notes (connecté) - GET /users/me (renvoi le user) (200 ok avec en body le user) pouvoir gérer les notes (connecté)
**Notes:**
- POST /notes (title optionnel, text optionnel, lié a user connecté) (201 creatred) - POST /notes (title optionnel, text optionnel, lié a user connecté) (201 creatred)
- PUT /notes/id (title optionnel, text optionnel) (200 ok avec en body la noté modifiée) - PUT /notes/id (title optionnel, text optionnel) (200 ok avec en body la noté modifiée)
- DELETE /notes/id (supprimer la note) (204 no content) - DELETE /notes/id (supprimer la note) (204 no content)