Skip to content

Commit 126f90c

Browse files
authored
Merge pull request #14 from Sandro642/feature/schematic
Feature: add schematic documentation and initialize method in Main class
2 parents e087a1e + e077207 commit 126f90c

3 files changed

Lines changed: 68 additions & 2 deletions

File tree

feature/schematic.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Feature/Schematic
2+
3+
Concernant la branche <a href="https://github.com/Sandro642/ConnectorAPI/tree/feature/schematic">Feature/Schematic</a>, Une amélioration sera faite du à la compatibilité de chaque utilisateur selon leur schéma utilisé dans leur API.
4+
5+
Voici un exemple de schéma :
6+
```{
7+
"err": false,
8+
"code": 200,
9+
"msg": "MCAS Version",
10+
"data": {
11+
"version": "V2-Alpha.0.1.0"
12+
}
13+
}
14+
```
15+
16+
Pour se faire à cette compatibilité il sera mis à disposition dans le fichier ```infos.yml``` une partie pour créer son propre schéma.
17+
18+
La classe <a href="https://github.com/Sandro642/ConnectorAPI/blob/main/src/main/java/fr/sandro642/github/api/ApiResponse.java">ApiResponse</a>, sera supprimé est remplacé par le nouveau système de schematic.
19+
20+
21+
Voici un exemple de ce que cela va ressembler :
22+
23+
```
24+
# properties Connector API By Sandro642
25+
26+
urlPath: "http://localhost:8080/api"
27+
28+
routes:
29+
#info: "/info/version"
30+
#ping: "/ping"
31+
#status: "/status"
32+
33+
34+
schema:
35+
#Activer la création de schéma ?
36+
enable: false
37+
38+
39+
#Schéma par défaut:
40+
# msg : string
41+
# err: boolean
42+
# code: integer
43+
# data: Map<String, Object>
44+
45+
46+
#Composants à créer exemple, je vais créer plusieurs composant:
47+
# str::msg
48+
# bln::status
49+
# int::code
50+
# map::data_string:object / string pour une chaine de caractère et
51+
# / object pour la récupération de n'importe
52+
# / quel type de variable.
53+
54+
# Grâce à cela vous pourrez les appeler pour récupérer vos propres valeurs
55+
# par rapport à votre schéma réponse API
56+
```

readme.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ Hook -----------------------|
2222
```
2323
---
2424

25+
Être tenu au courant des dernière features et mises à jour de ConnectorAPI
26+
27+
- [Feature/Schematic](feature/schematic.md)
28+
29+
---
30+
2531
Changelog :
2632

2733
```java

src/test/java/fr/sandro642/github/test/Main.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@
88
import fr.sandro642.github.jobs.misc.VersionType;
99
import org.junit.jupiter.api.Test;
1010

11-
import java.util.HashMap;
12-
1311
/**
1412
* Main est une classe de test pour vérifier la création du fichier YML et pleins d'autres fonctionnalités de la librairie.
1513
* @author Sandro642
@@ -19,6 +17,12 @@
1917

2018
public class Main {
2119

20+
@Test
21+
public void initializeCAPI() {
22+
ConnectorAPI.initialize(ResourceType.TEST_RESOURCES);
23+
}
24+
25+
2226
public static void main(String[] args) {
2327
ConnectorAPI.initialize(ResourceType.TEST_RESOURCES);
2428

0 commit comments

Comments
 (0)