Files
api.pawol.nu/README.md
T

79 lines
2.0 KiB
Markdown
Raw Normal View History

2020-12-20 19:19:18 +01:00
# API made with Strapi
2020-12-04 20:12:49 +01:00
2024-02-05 16:43:40 +01:00
<p align="center">
<a href="https://liberapay.com/OKI/donate/">
<img src="https://img.shields.io/liberapay/receives/OKI.svg?logo=liberapay">
<img src="https://img.shields.io/liberapay/patrons/OKI.svg?logo=liberapay">
<img src="https://img.shields.io/liberapay/goal/OKI.svg?logo=liberapay">
</a>
</p>
2020-12-20 19:19:18 +01:00
## Prérequis
2024-02-05 09:28:53 +01:00
- Node >= 16
2020-12-20 19:19:18 +01:00
- Npm ou Yarn
2020-12-04 20:12:49 +01:00
2020-12-20 19:19:18 +01:00
## Variables d'environnement
- Copier le contenu du fichier `.env.sample` dans un nouveau fichier `.env`
```
cp .env.sample .env
```
2020-12-04 20:12:49 +01:00
2020-12-20 19:19:18 +01:00
`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`)*.
2020-12-21 09:48:57 +01:00
`STRAPI_ADMIN_URL` fait référence à la route pour accéder à l'espace d'administration *(par défaut : `/admin`)* .
2020-12-20 19:19:18 +01:00
2022-11-10 01:36:38 +04:00
## 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.
2020-12-20 21:18:34 +01:00
## Installation des dépendances & lancement du serveur
2020-12-20 19:19:18 +01:00
```
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
___
2024-02-05 09:28:53 +01:00
### `/paroles`
2020-12-20 19:19:18 +01:00
- `GET` : Lister tous les textes
2024-02-05 09:28:53 +01:00
### `/paroles/{id}`
2020-12-20 19:19:18 +01:00
- `GET` : Récupérer les informations d'un texte
2024-02-05 09:28:53 +01:00
### `/paroles/count`
2020-12-20 19:19:18 +01:00
- `GET` : Récupère le nombre de texte