72 lines
1.7 KiB
Markdown
72 lines
1.7 KiB
Markdown
# API made with Strapi
|
|
|
|
## Prérequis
|
|
- Node >= 16
|
|
- Npm ou Yarn
|
|
- Mongo >= 4.x
|
|
|
|
## Variables d'environnement
|
|
- Copier le contenu du fichier `.env.sample` dans un nouveau fichier `.env`
|
|
```
|
|
cp .env.sample .env
|
|
```
|
|
|
|
`STRAPI_URL` sera utile en production uniquement. Cette variable fait référence à l'url du site de production *(exemple : `https://api.mon-site.fr`)*.
|
|
|
|
`STRAPI_ADMIN_URL` fait référence à la route pour accéder à l'espace d'administration *(par défaut : `/admin`)* .
|
|
|
|
## Générer les clés nécessaires :
|
|
|
|
Ces variables d'environnement sont obligatoires :
|
|
|
|
- **APP_KEYS**
|
|
- **API_TOKEN_SALT**
|
|
- **ADMIN_JWT_SECRET**
|
|
- **JWT_SECRET** *(générée automatique si non renseignée)*
|
|
|
|
Afin de les renseigner, vous pouvez générer des clés en passant par node :
|
|
|
|
```bash
|
|
node
|
|
```
|
|
|
|
Une fois dans la console node, tapez :
|
|
|
|
```bash
|
|
crypto.randomBytes(16).toString('base64')
|
|
```
|
|
*retourne par exemple : 'BwUANVKSfenqAs1eFBHDIA=='*
|
|
|
|
Générez une clé pour chaque variable et ajoutez les au fichier .env.
|
|
La varialbe APP_KEYS peut en contenir plusieurs séparées, par une virgule :
|
|
*APP_KEYS=BwUANVKSfenqAs1eFBHDIA==,GiznuBga8kH0ZcOM5YO85w==*
|
|
|
|
Si la variable JWT_SECRET n'est pas renseignée, elle est générée automatiquement par Strapi.
|
|
|
|
## Installation des dépendances & lancement du serveur
|
|
|
|
```
|
|
yarn && yarn build && yarn dev
|
|
```
|
|
|
|
## Point d'accès
|
|
|
|
### `/awtis`
|
|
- `GET` : Lister tous les artistes
|
|
|
|
### `/awtis/{id}`
|
|
- `GET` : Récupérer les informations d'un artiste
|
|
|
|
### `/awtis/count`
|
|
- `GET` : Récupère le nombre d'artiste
|
|
___
|
|
|
|
### `/paroles`
|
|
- `GET` : Lister tous les textes
|
|
|
|
### `/paroles/{id}`
|
|
- `GET` : Récupérer les informations d'un texte
|
|
|
|
### `/paroles/count`
|
|
- `GET` : Récupère le nombre de texte
|