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

Updated documentation & GSON.

parent 2829a735
Branches
1 merge request!14Documentation overhaul. #1
...@@ -15,12 +15,14 @@ sur les produits disponibles tels que les prix de chaque article. ...@@ -15,12 +15,14 @@ sur les produits disponibles tels que les prix de chaque article.
### Documentation ### Documentation
L'API REST est documentée à travers un document OpenAPI qui peut être visionné [Accueil documentation](https://erp-sil.pages.unistra.fr/back/)
sur l'éditeur en ligne [SwaggerHub](https://editor.swagger.io/).
L'API REST est documentée à travers un document OpenAPI qui peut être consulté
[ici](https://erp-sil.pages.unistra.fr/back/openapi/index.html).
La documentation Java (Javadoc) du projet est généré automatiquement par 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` 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). et peut être consultée [ici](https://erp-sil.pages.unistra.fr/back/javadoc/index.html) (en anglais).
### Exécution ### Exécution
...@@ -31,7 +33,7 @@ Gradle permet d'essayer rapidement l'application en lançant un serveur ...@@ -31,7 +33,7 @@ Gradle permet d'essayer rapidement l'application en lançant un serveur
Web de test [Apache TomCat](https://tomcat.apache.org/) hébergeant Web de test [Apache TomCat](https://tomcat.apache.org/) hébergeant
le programme. Il permet également de la déployer rapidement sous la forme le programme. Il permet également de la déployer rapidement sous la forme
d'une archive WAR pouvant être installée sur un serveur de production d'une archive WAR pouvant être installée sur un serveur de production
Apache TomCat ou [Oracle Glassfish](https://www.oracle.com/middleware/technologies/glassfish-server.html). Apache TomCat ou [Eclipse Glassfish](https://glassfish.org/).
Il est conseillé d'utiliser un IDE Java pour exécuter et déployer l'application. Il est conseillé d'utiliser un IDE Java pour exécuter et déployer l'application.
...@@ -85,8 +87,7 @@ ou, sur Microsoft Windows, ...@@ -85,8 +87,7 @@ ou, sur Microsoft Windows,
### Appel de l'API ### Appel de l'API
Passez par [SwaggerHub](https://editor.swagger.io/) pour ouvrir le fichier `back-openapi.yaml`, Vous pouvez trouver la documentation [ici](https://erp-sil.pages.unistra.fr/back/openapi/index.html).
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.
......
...@@ -16,11 +16,13 @@ price. ...@@ -16,11 +16,13 @@ price.
### Documentation ### Documentation
[Documentation Home](https://erp-sil.pages.unistra.fr/back/)
The RESTful API is documented through an OpenAPI specification file that you can The RESTful API is documented through an OpenAPI specification file that you can
open through [SwaggerHub](https://editor.swagger.io/). view [here](https://erp-sil.pages.unistra.fr/back/openapi/index.html).
The project's Javadoc is automatically generated through CI for each commit 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/). on the `master` branch and can be found [here](https://erp-sil.pages.unistra.fr/back/javadoc/index.html).
### Running ### Running
...@@ -81,8 +83,7 @@ or, on Microsoft Windows, ...@@ -81,8 +83,7 @@ or, on Microsoft Windows,
### Calling the API ### Calling the API
Go to [SwaggerHub](https://editor.swagger.io/) to open the `back-openapi.yaml` file, which is You can view the documentation [here](https://erp-sil.pages.unistra.fr/back/openapi/index.html).
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.
......
...@@ -15,9 +15,9 @@ repositories { ...@@ -15,9 +15,9 @@ repositories {
dependencies { dependencies {
implementation 'org.xerial:sqlite-jdbc:3.36.0.3' implementation 'org.xerial:sqlite-jdbc:3.36.0.3'
implementation group: 'com.google.code.gson', name: 'gson', version: '2.7' implementation group: 'com.google.code.gson', name: 'gson', version: '2.8.8'
implementation 'org.springframework.boot:spring-boot-starter-web' implementation 'org.springframework.boot:spring-boot-starter-web'
providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat' providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat'
......
...@@ -39,7 +39,7 @@ ...@@ -39,7 +39,7 @@
window.onload = function() { window.onload = function() {
// Begin Swagger UI call region // Begin Swagger UI call region
const ui = SwaggerUIBundle({ const ui = SwaggerUIBundle({
url: "https://petstore.swagger.io/v2/swagger.json", url: "https://erp-sil.pages.unistra.fr/back/openapi/openapi.json",
dom_id: '#swagger-ui', dom_id: '#swagger-ui',
deepLinking: true, deepLinking: true,
presets: [ presets: [
......
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