diff --git a/README.md b/README.md index 14f57e7..73c441c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,67 @@ # api-server -Le serveur API de gambling.aindustries.be \ No newline at end of file +Le serveur API de gambling.aindustries.be + +## All API endpoints + +### /items + +##### Permet de récupérer tout les items de la base de données + +Utilisation: + +```ts +const {data, errors} = await fetch("/items").then(r => r.json()); +``` + +### /item + +##### Permet de récupérer les informations d'un item + +Utilisation: + +```ts +let uuid; // Some uuid +const {data, errors} = await fetch(`/item?uuid=${uuid}`).then(r => r.json()); +``` + +### /item-cases + +##### Permet de récupérer toutes les cases où un item est + +Utilisation: + +```ts +let uuid; // Some uuid +const {data, errors} = await fetch(`/item-cases?uuid=${uuid}`).then(r => r.json()); +``` + +##### Le même endpoint existe pour les cases: /cases, /case, /case-items + +## Data Representation + +### Item + +```json +{ + "uuid": "eee91ea1-1827-482b-b298-63bd6eda0221", + "name": "AWP Lightning Strike", + "rarity": 5, + "image": "/images/items/AWP_Lightning_Strike.png", + "price": "85.36" +} +``` + +> [!NOTE] +> Rarity entre 0 et 6 (du moins rare au plus rare) + +### Case + +```json +{ + "uuid": "26684b79-32ff-4fa2-b026-b4f26ab2132a", + "name": "CS:GO Weapon Case", + "image": "/images/cases/CS:GO_Weapon_Case.png", + "price": 85.36 +} +``` \ No newline at end of file