Skip to content
Snippets Groups Projects
Commit 3bcd6e1e authored by BEAUVAIS ANTOINE's avatar BEAUVAIS ANTOINE
Browse files

Updated READMEs with documentation info.

parent c26c3211
Branches
1 merge request!12Javadoc updates.
...@@ -13,6 +13,15 @@ responsable de la gestion des stocks pour les articles à vendre. ...@@ -13,6 +13,15 @@ responsable de la gestion des stocks pour les articles à vendre.
L'application fournit également aux autres services les informations L'application fournit également aux autres services les informations
sur les produits disponibles tels que les prix de chaque article. sur les produits disponibles tels que les prix de chaque article.
### Documentation
L'API REST est documentée à travers un document OpenAPI qui peut être visionné
sur l'éditeur en ligne [SwaggerHub](https://editor.swagger.io/).
La documentation Java (Javadoc) du projet est généré automatiquement par
le système d'intégration continue (CI) pour chaque révision de la branche `master`
et peut être consultée [ici](https://erp-sil.pages.unistra.fr/back/) (en anglais).
### Exécution ### Exécution
BACK est une application Web [Java Spring](https://spring.io/) utilisant BACK est une application Web [Java Spring](https://spring.io/) utilisant
...@@ -76,7 +85,8 @@ ou, sur Microsoft Windows, ...@@ -76,7 +85,8 @@ ou, sur Microsoft Windows,
### Appel de l'API ### Appel de l'API
TODO: Ajouter la spécification OpenAPI. Passez par [SwaggerHub](https://editor.swagger.io/) pour ouvrir le fichier `back-openapi.yaml`,
qui est un document OpenAPI.
Utilisez [Postman](https://www.postman.com/) ou [Advanced REST Client](https://install.advancedrestclient.com/install) pour l'appeler l'API REST. Utilisez [Postman](https://www.postman.com/) ou [Advanced REST Client](https://install.advancedrestclient.com/install) pour l'appeler l'API REST.
......
...@@ -14,6 +14,14 @@ It also provides other components information about the available ...@@ -14,6 +14,14 @@ It also provides other components information about the available
products such as the number of each article in stock as well as their products such as the number of each article in stock as well as their
price. price.
### Documentation
The RESTful API is documented through an OpenAPI specification file that you can
open through [SwaggerHub](https://editor.swagger.io/).
The project's Javadoc is automatically generated through CI for each commit
on the `master` branch and can be found [here](https://erp-sil.pages.unistra.fr/back/).
### Running ### Running
BACK is a [Java Spring](https://spring.io/) Web application built using BACK is a [Java Spring](https://spring.io/) Web application built using
...@@ -73,7 +81,8 @@ or, on Microsoft Windows, ...@@ -73,7 +81,8 @@ or, on Microsoft Windows,
### Calling the API ### Calling the API
TODO: Add OpenAPI specification. Go to [SwaggerHub](https://editor.swagger.io/) to open the `back-openapi.yaml` file, which is
an OpenAPI specification document.
Use [Postman](https://www.postman.com/) or [Advanced REST Client](https://install.advancedrestclient.com/install) to make calls to the RESTful API. Use [Postman](https://www.postman.com/) or [Advanced REST Client](https://install.advancedrestclient.com/install) to make calls to the RESTful API.
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment