Format d'un JSON pour une API REST

Version imprimable

Bonjour,

J'ai un système qui collecte des données à des fréquences variables suivant le type de données :
données_de_type_a: toutes les 20s
données_de_type_b: toutes les 30s
données_de_type_c: à la seconde 44 uniquement

Je souhaite réaliser une API pour exposer ces données. un appel pour toutes les données.

Je recherche quelle est la meilleure structure de la réponse (ie. plus simple à réutiliser pour un dev autre que moi)

quelque chose comme ca ?

Code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
    {
        "data": [
            { 
                "données_de_type_a": [
                    {
                        "valeur" : 0,
                        "timestamp" : 12345678940
                     },
                    {
                        "valeur" : 3,
                        "timestamp" : 12345678920
                     },
                     {
                        "valeur" : 1,
                        "timestamp" : 12345678900
                     } ],
                "données_de_type_b":[{
                    "valeur" : "ABC",
                    "timestamp" : 12345678930
                 },{
                    "valeur" : "TITI",
                    "timestamp" : 12345678900
                 }],
                "données_de_type_c":[{
                    "valeur" : { "clée" : 1, "valeur": "zzz"},
                    "timestamp" : 12345678944
                 }
        ]
    }

ou comme ca ?

Code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
    {
        "data": [
            { 
                "données_de_type_a": 
                    {
                        "12345678940" : 0,
                        "12345678920" : 3,
                        "12345678900" : 1
                     } ,
                "données_de_type_b":{
                    "12345678930" : "ABC",
                    "12345678900" : "TITI"
                 },
                "données_de_type_c":{
                    "12345678944" : { "clée" : 1, "valeur": "zzz"}
                 }
        ]
    }

ou avez-vous une autre idée ?

Merci !

15/09/2015, 17h02
Lady

La seconde solution me semble bizarre tu a des sous objets avec des nombre de champs variables difficile à retransformer en objet Java derrière.

En plus la version 1 te permet de rajouter des info si un jour tu as plus qu'un couple date/valeur pour une donnée.

Donc je vote 1 !

Il serai plus logique de conserver la logique de récolte :

Code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
    {
        "data": [
            { 
                "mesures": [
                    {
                        "timestamp" : 12345678940,
                        "données_de_type_a" : 0
                     },
                    {
                        "timestamp" : 12345678900,
                        "données_de_type_a" : 1,
                        "données_de_type_b" : "ABC"
                     },
                     {
                        "timestamp" : 12345678930,
                        "données_de_type_a" : 3,
                        "données_de_type_b" : "AZEDZEF",
                        "données_de_type_c":[{
                            "valeur" : { "clée" : 1, "valeur": "zzz"},
                        } ],
                 }
        ]
    }

Ainsi, tu as une liste de mesures qui ont une date et une liste de valeurs. Il est possible de mettre les données dans une sous-liste pour rendre la chose plus générique. et permettre un mapping simple vers un objet de type Map.

Cordialement,
Patrick Kolodziejczyk.