Skip to content
Snippets Groups Projects

README changes.

Merged BEAUVAIS ANTOINE requested to merge develop into master
Viewing commit b4b2c2ca
Show latest version
2 files
+ 80
2
Preferences
Compare changes
Files
2
+ 42
1
@@ -30,4 +30,45 @@ Il est conseillé d'utiliser un IDE Java pour exécuter et déployer l'applicati
* [Apache NetBeans](https://netbeans.apache.org/) (gratuit et *open-source*)
* [Eclipse IDE for Java Developers](https://www.eclipse.org/downloads/packages/) (grauit et *open-source*)
TODO: Insérer les commandes Gradle.
#### Préparation
Assurez-vous que votre machine possède un kit de développement Java (JDK) version
**8 ou ultérieur**. Le JDK complet est requis pour compiler l'application. Le fichier WAR
peut être déployé sur une machine ne possédant que la JRE.
Afin que l'application fonctionne, vous devez configurer une clé d'authentification
pour l'API de l'application.
Dans `src/main/resources`, créez un nouveau fichier `apikey.properties` contenant :
```
api.key=MyApiKey
```
#### Compilation et exécution
Vous pouvez compiler et lancer le projet en utilisant la commande suivante sur
un système UNIX ou UNIX-like :
```
./gradlew bootRun
```
Sur Microsoft Windows, utilisez :
```
.\gradlew bootRun
```
Quand l'application tourne, vous pouvez y accéder à travers l'adresse URL
[http://127.0.0.1:8080/](http://127.0.0.1:8080/).
### Appel de l'API
TODO: Ajouter la spécification OpenAPI.
Utilisez [Postman](https://www.postman.com/) ou [Advanced REST Client](https://install.advancedrestclient.com/install) pour l'appeler l'API REST.
Tous les appels vers l'API doivent posséder la clé d'authentification configurée
dans le fichier `apikey.properties` de l'application. Elle doit être spécifiée
dans l'en-tête HTTP `apikey`.
\ No newline at end of file