api-expositiondonneesentrees

API permettant d'envoyer des données d'entrées dans le système NumEcoEval. L'import de données peut se faire via des fichiers CSV respectant un format spécifique ou au format JSON. Le contrat d'interface est disponible au format OpenAPI 3.

Pré-requis

• JDK 21
  • Open JDK
  • Coretto
• Maven 3
• Un IDE compatible avec Maven 3 et JDK 21

Build

Pour compiler l'application, utilisez la commande suivante :

mvn clean install

API REST et Contrat OpenAPI

Le contrat OpenAPI 3 est disponible dans les ressources du projet : openapi.yaml

Ce contrat est utilisé pour générer les interfaces et POJOs utilisés dans les communications REST via le plugin Maven openapi-generator-maven-plugin

Profiles Maven

• DEPENDENCY-CHECK : Un profile permettant un scan local des dépendances Maven avec le dependency-check Maven plugin d'OWASP.

Configuration de l'application

Editer le fichier application.yml

Démarrer l'application

Pour démarrer l'application avec la configuration actuelle, utilisez la commande suivante:

mvn spring-boot:run

Avec la configuration par défaut, l'API REST sera disponible sur l'URL suivante : http://localhost:18081

L'application utilise Springdoc-openapi permettant un affichage via Swagger-UI sur l' URL http://localhost:18081/api/swagger-ui/index.html.

• Par défaut, le contrat d'interface OpenAPI est également disponible sur l' URL http://localhost:18081/openapi.yaml.

Licences

Apache 2.0

Liens utiles

• Spring Documentation (version courante)
• Spring Boot Documentation (version courante)