From 3bcd6e1e2f7e02dc5aa1094ea234888b88decfc5 Mon Sep 17 00:00:00 2001 From: BEAUVAIS ANTOINE <antoine.beauvais@etu.unistra.fr> Date: Sat, 25 Sep 2021 12:54:10 +0200 Subject: [PATCH] Updated READMEs with documentation info. --- README.fr.md | 12 +++++++++++- README.md | 11 ++++++++++- 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/README.fr.md b/README.fr.md index cd28ca0..78405d3 100644 --- a/README.fr.md +++ b/README.fr.md @@ -13,6 +13,15 @@ responsable de la gestion des stocks pour les articles à vendre. L'application fournit également aux autres services les informations 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 BACK est une application Web [Java Spring](https://spring.io/) utilisant @@ -76,7 +85,8 @@ ou, sur Microsoft Windows, ### 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. diff --git a/README.md b/README.md index 5f46033..8f8b31f 100644 --- a/README.md +++ b/README.md @@ -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 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 BACK is a [Java Spring](https://spring.io/) Web application built using @@ -73,7 +81,8 @@ or, on Microsoft Windows, ### 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. -- GitLab