add api description

master
remrem 2 years ago
parent 987a97e6e6
commit 9c362a1084

@ -1 +1,24 @@
# API # API
## Links
- [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete)
- [HTTP Status Codes](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status)
## Rappel
**GET**: Récupère la ressource demandé.
**HEAD**: GET - body.
**POST**: Création d'une ressource envoyé dans le body.
**PUT**: POST + remplacement.
**PATCH**: Modification d'une ressource.
**DELETE**: Supprime la ressource spécifié.
## Endpoints
POST /user/ Création d'un user.
DELETE /user/{token} Suppression d'un user.
GET /user/{uuid}/{hash}/token Récupération d'un token valide.
GET /user/{token}/files Récupération de la liste des fichier de donnée.
POST /user/{token}/files Upload d'un fichier par un user.
GET /user/{token}/files/{file_uuid} Récupération d'un fichier par user.
DELETE /user/{token}/files/{file_uuid} Suppression d'un fichier par user.
PUT /user/{token}/mail Modification de l'email.
PUT /user/{token}/username Modification du username.

@ -18,6 +18,7 @@ classDiagram
class File{ class File{
uuid id uuid id
string title
date import_date date import_date
blob file blob file
} }

Loading…
Cancel
Save