API Personnelle

---

À propos de l'API

Voici mon API personnelle, disponible sur le domaine api.sylvain.pro. L'API est développée avec Node.js et hébergée 24h/7j. Elle est simple d'utilisation et a une documentation disponible sur docs.sylvain.pro !

Une limite de 2000 requêtes par heure est fixée. Elle change pour certains endpoints nécessitant plus de ressources. Si vous souhaitez une augmentation de cette limite, n'hésitez pas à visiter la documentation.

Installer le paquet de l'API sur votre machine

$ sudo apt install nodejs npm
$ npm install @20syldev/api
$ npm init

Attention, vous devez configurer le type sur "module" dans votre fichier package.json.

Pour utiliser le paquet dans votre projet, créez un fichier JavaScript. Par exemple, index.js :

import '@20syldev/api';

Puis, démarrez un serveur Node.js pour utiliser l'API :

$ node index.js
API is running on
    - http://127.0.0.1:3000
    - http://localhost:3000

Remplacez index.js par le nom de votre fichier JavaScript.

Tester l'API sur votre machine

Téléchargez la dernière mise à jour de l'API, puis extrayez le contenu du fichier .zip ou .tar.gz dans un de vos répertoires. Ensuite, déplacez-vous dans le dossier du projet, via un terminal Linux, Windows ou macOS :

$ cd /chemin/vers/le/projet

Enfin, exécutez le script de build, qui installera les dépendances et lancera le serveur de l'API :

$ npm run build

> @20syldev/[email protected] build
> npm install && node app.js

[...]

found 0 vulnerabilities
API is running on
    - http://127.0.0.1:3000
    - http://localhost:3000

Visitez la documentation dédiée, vous y retrouverez des exemples de requêtes et des codes simples pour tester l'API !