Skip to content

A REST API example built with Spring Boot

License

Notifications You must be signed in to change notification settings

Andreaj42/API-REST

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API Rest Spring Boot

Description

Bienvenue dans ce projet d'API REST développé avec Spring Boot. Cette API permet, au travers de requête REST la gestion de joueurs et d'équipes de football.

Prérequis

Avant de commencer, assurez-vous d'avoir installé les éléments suivants :

Installation

Production

  1. Téléchargez le fichier JAR (Java archive) depuis le lien suivant :

  2. Puis, exécutez le JAR

     java -Dfile.encoding=UTF-8 -jar td_springboot-0.0.1-SNAPSHOT.jar

Développement

  1. Clonez le dépôt :

    git clone https://github.com/Andreaj42/API-REST.git
    cd td-rest-api
  2. Compilez le projet avec Maven :

    mvn clean install
  3. Exécutez l'application :

    java -jar target/td-rest-api.jar

L'API devrait maintenant être accessible à l'adresse http://localhost:8080/api/v1.

Exemple d'utilisation

  • Endpoint : GET /api/v1/example
  • Description : Récupère la liste des équipes disponibles.
    curl http://localhost:8080/api/v1/teams

Exemple d'utilisation via Axios

Dans le dossier scripts, il existe des scripts Node.js d'exemples d'utilisation de l'API. Assurez-vous d'utiliser les commandes suivantes pour exécuter ces scripts.

 npm install
 node script/getTeams.js

About

A REST API example built with Spring Boot

Resources

License

Stars

Watchers

Forks

Packages

No packages published