diff --git a/doc/API.md b/doc/API.md index 400cec0c3c94bb4a7360e98089eb66b7232ef01d..0a0b023c4fd5640f0592bc0afe4e1c687edbb7e4 100644 --- a/doc/API.md +++ b/doc/API.md @@ -1,16 +1,42 @@ # Documentation API -L'api permet d'effectuer les actions suivantes sur les routes données : +## Utilisation de l'API -1. `api/toucans` : +L'API permet de récuper et de poster des toucans et leurs couvertures. Les requetes POST sont toutes protégées : Il faut mettre dans les headers `token` avec le token jwt donnée par l'api en début de session. - * `GET`: Renvoie une liste contenant tous les toucans de la bdd. Les toucans sont sous la forme d'objets avec les champs _id, date et title. +L'api possède les routes : + +1. `toucan/toucans` : + +* `GET`: Renvoie une liste contenant tous les toucans de la bdd. Les toucans sont sous la forme d'objets avec les champs _id, date et title. + + * `limit` : Int en paramètre, il permet de ne pas récupérer plus de limit toucans. - * `POST` : Permet de sauvegarder un toucan, prend en champs : +* `POST` : Permet de sauvegarder un toucan, prend en champs : + + * `date` : Au format Date + * `title` : Une String + * `toucan` : Un pdf + * `cover` : Au format png ou jpg + + Si l'oppération est un succès, on renvoie un message de succès et l'id du toucan enregistré. + +2. `toucan/pdf/:id` : + +* `GET` Renvoie le pdf du toucan avec id comme _id dans la base de donnée. - * `date` : Au format Date - * `title` : Une String - * `toucan` : Un pdf - * `cover` : Au format png ou jpg +3. `toucan/img/:id` : + +* `GET` Renvoie la cover du toucan avec id comme _id dans la base de donnée. - Si l'oppération est un succès, on renvoie un message de succès et l'id du toucan enregistré. \ No newline at end of file +4. `toucan/delete/:id` : + +* `POST` Supprimer le toucan avec id comme _id dans la base de donnée. + +5. `oauth/login` + +* `GET` s'authentifier auprès de l'oauth. + +6. `oauth/callback` + +* `GET` Permet de récupérer un token d'authentification après connexion à l'oauth. \ No newline at end of file diff --git a/front/src/App.js b/front/src/App.js index 996cc9f9ce58a1d988b74094a809cb9fbcf9f920..835635c5a102c5a136aabc737f1e9731c9b38bc6 100644 --- a/front/src/App.js +++ b/front/src/App.js @@ -8,10 +8,10 @@ import isLogged from './utils/Oauth'; function App() { return ( - <Router > - <Route exact path='/' render={()=>isLogged() ? <MainPage/> : window.location=`${env.backURL}/oauth/login`}/> - <Route exact path='/login/:token' component={Login} /> - </Router> + <Router > + <Route exact path='/' render={()=>isLogged() ? <MainPage/> : window.location=`${env.backURL}/oauth/login`}/> + <Route exact path='/login/:token' component={Login} /> + </Router> ); } diff --git a/front/src/temp.env.json b/front/src/temp.env.json index 6c184adf5d6caab7bf76a3ca9995c0437cd62c36..a046b837ce9a6843c96a9590f2516f75d9e5297f 100644 --- a/front/src/temp.env.json +++ b/front/src/temp.env.json @@ -1,4 +1,5 @@ { - "frontURL": "http://localhost:3000/", - "backURL": "http://localhost:8000" + "frontURL": "http://localhost:3000", + "backURL": "http://localhost:8000", + "logOutURL": "https://auth.viarezo.fr/logout" } \ No newline at end of file diff --git a/front/src/view/LogoutButton.js b/front/src/view/LogoutButton.js index 70ff41df02661ab0c7ed0685432eb788ec4b58c5..ab5941687357f722dab7f8c469ebe830bdaee838 100644 --- a/front/src/view/LogoutButton.js +++ b/front/src/view/LogoutButton.js @@ -16,7 +16,7 @@ class LogoutButton extends Component { color="violet" icon> <Icon name="power" style={{ paddingRight:"2em" }}/> - Déconexion + Déconnexion </Button> } }