Otterly API - Api Serveur

GitHub all releases GitHub language count GitHub top language

Otterly API est une API RESTful. Elle est conçue pour être simple d'utilisation et facile à maintenir. Son objectif est de devenir un véritable framework d'API, pensé pour être hautement modifiable et extrêmement facile à prendre en main. Cette API est spécialisée pour l'Antre des Loutres, mais elle reste facilement modifiable pour s'adapter à un environnement différent.

Sommaire

Otterly API
Sommaire

Fonctionnalités

Gestion de table, Création, Suppression, Recherche de données.
Protocole de token d'authentification pour les requêtes demandant l'authentification.
Lancement de commande dans un terminal.

Installation

Pour installer l'API, suivez les étapes suivantes :

Clonez le dépôt GitHub :

git clone https://github.com/matheo-1712/OtterlyAPI.git

Installez les dépendances :

npm install

Configurez les variables d'environnement :

cp .env.example .env

Démarrez l'API :

npm run dev

Exemple d'utilisation

Création d'un serveur

Pour créer un serveur, vous devez utiliser la route POST /api/serveurs avec le corps JSON suivant :

import axios from 'axios';

const url = 'http://localhost:3000/api/serveur';
const token = 'VOTRE_TOKEN_ICI';

axios.post(url, {
    nom: "Serveur Test",
    jeu: "Minecraft",
    version: "1.19.2",
    modpack: "Minecraft",
    modpack_url: "https://www.minecraft.net/en-us/download/server/vanilla",
    nom_monde: "Test",
    embed_color: "#000000",
    path_serv: "C:/Users/perod/Documents/API-Serveur/API Serveur TS/serveur.bat",
    start_script: "start",
    actif: true,
    global: false,
}, {
    headers: {
        'Authorization': `${token}`
    }
})
.then(response => {
    console.log(response.status); // Affiche le code de réponse HTTP, ex: 201
})
.catch(error => {
    console.error(error); // Affiche l'erreur si la requête échoue
});

Récupération de tous les serveurs

Pour récupérer tous les serveurs, vous devez utiliser la route GET /api/serveurs avec le corps JSON suivant :

import axios from 'axios';

    axios.get(url)
        .then(response => {
            console.log(response.data);
        })
        .catch(error => {
            console.error(error);
        });