Projet API REST Generaliste publique

[Guiguiabloc]

ahah, en fait non tu peux laisser une réponse directe, quoi je suis chiant ? comprends pas

mouarf

Nan mais la question se pose réellement car je me la suis posée longuement.
Faut-il à une réponse simple (1 seul élement (oui/non/valeur)) retourner une donnée brute ou l'encapsuler dans un json ?
Dans le premier cas, cela oblige l'utilisateur à le parser (et tout le monde ne maitrise pas forcément un traitement de json) mais on reste "API Compliant" ou dans le deuxième, c'est tout bête, la valeur retournée est la réponse, point barre.
Alors oui le débat est ouvert. Quelle est la meilleure réponse ?

[Calcipher]

Nan mais la question se pose réellement car je me la suis posée longuement.
Faut-il à une réponse simple (1 seul élement (oui/non/valeur)) retourner une donnée brute ou l'encapsuler dans un json ?
Dans le premier cas, cela oblige l'utilisateur à le parser (et tout le monde ne maitrise pas forcément un traitement de json) mais on reste "API Compliant" ou dans le deuxième, c'est tout bête, la valeur retournée est la réponse, point barre.
Alors oui le débat est ouvert. Quelle est la meilleure réponse ?

Alors à mon avis, l'api pourrait s'enrichir pour donner d'un seul coup plusieurs infos sur le jour actuel (vacances scolaires en plus de férié par exemple), donc il vaut mieux rester sur un tableau json.
Sinon sur le contenu de la réponse, plutôt que yes/no j'aurais mis true/false car c'est un booléen (mais je chipote...).

[Guiguiabloc]

Alors à mon avis, l'api pourrait s'enrichir pour donner d'un seul coup plusieurs infos sur le jour actuel (vacances scolaires en plus de férié par exemple), donc il vaut mieux rester sur un tableau json.
Sinon sur le contenu de la réponse, plutôt que yes/no j'aurais mis true/false car c'est un booléen (mais je chipote...).

Alors j'ai simplifié le tout pour les réponses à 1 seul élément. Par défaut la réponse est en format raw (brut)
en spécifiant /json la fin de la requête, la réponse est restituée en json

(et j'ai remplacé no par False )

http://api.domogeek.fr/static/doc/index.html

[Guiguiabloc]

[UPDATE]

Ajout de la fonction vacances scolaires

exemple d'appels:
curl http://api.domogeek.fr/schoolholiday/A/now
curl http://api.domogeek.fr/schoolholiday/A/now/json
curl http://api.domogeek.fr/schoolholiday/A/all
curl http://api.domogeek.fr/schoolholiday/A/25-12-2014/json

Doc: http://api.domogeek.fr/static/doc/index.html#api-Domogeek-GetSchoolHoliday

[giejo]

Punaise ! c'est une vrai bonne idée !
moi qui me tapait le calendrier google pour les jours fériés etc
Bravo Guigui

Une idée, je ne sais pas si elle est valable, j'utilise aussi l'alerte meteo qui a ete developpé je ne sais plus par qui ici... (désolé) est ce que ce ne serait pas intéressant d'agréger aussi ce type de developpement au sein de cette api ??

[Calcipher]

Bonjour,

Avant de passer à la météo ou autres, je pense qu'il faut finir avec les types de jours.
Après les jours fériés et les jours de vacances, il faudrait obtenir :
- Les jours ouvrés (ni samedi, ni dimanche, ni férié)
- Les jours d'école (jour ouvré en dehors des vacances)

L'idéal serait d'avoir les 4 types(férié, vacances, ouvré et école) dans un même json pour une date donnée.

Cdt,

[Guiguiabloc]

Punaise ! c'est une vrai bonne idée !
moi qui me tapait le calendrier google pour les jours fériés etc
Bravo Guigui

Une idée, je ne sais pas si elle est valable, j'utilise aussi l'alerte meteo qui a ete developpé je ne sais plus par qui ici... (désolé) est ce que ce ne serait pas intéressant d'agréger aussi ce type de developpement au sein de cette api ??

Merci giejo Ca me fait vraiment plaisir

La météo est dans ma TODO list

[Guiguiabloc]

Bonjour,

Avant de passer à la météo ou autres, je pense qu'il faut finir avec les types de jours.
Après les jours fériés et les jours de vacances, il faudrait obtenir :
- Les jours ouvrés (ni samedi, ni dimanche, ni férié)
- Les jours d'école (jour ouvré en dehors des vacances)

L'idéal serait d'avoir les 4 types(férié, vacances, ouvré et école) dans un même json pour une date donnée.

Cdt,

Allez, un premier lot de livraison avant de regrouper tout cela

[UPDATE]

Ajout Week-end

Savoir si aujourd'hui, demain ou tel jour est un week-end :

curl http://api.domogeek.fr/weekend/now
curl http://api.domogeek.fr/weekend/tomorrow
curl http://api.domogeek.fr/weekend/28-06-2014

Retourne "True" si c'est pendant le week-end, "False" sinon. (ajouter /json pour un retour en json)

http://api.domogeek.fr/static/doc/index ... GetWeekend

[Guiguiabloc]

L'idéal serait d'avoir les 4 types(férié, vacances, ouvré et école) dans un même json pour une date donnée.

[UPDATE]

Ajout de la fonction holidayall (retourne un json sur la date (maintenant ou une date spécifiée) contenant férié, week-end et vacances scolaires (zone à spécifier)

curl http://api.domogeek.fr/holidayall/A/now

{"holiday": "False", "weekend": "False", "schoolholiday": "Vacances d'été"}

curl http://api.domogeek.fr/holidayall/A/25-02-2014

{"holiday": "False", "weekend": "False", "schoolholiday": "False"}

http://api.domogeek.fr/static/doc/index ... Holidayall

(et 3 suffisent, si 3 = False alors forcément ecole = True :p)

[Calcipher]

Ajout de la fonction holidayall (retourne un json sur la date (maintenant ou une date spécifiée) contenant férié, week-end et vacances scolaires (zone à spécifier)

C'est cool ça, y'a qu'a demander...
Bravo et merci pour le boulot et la réactivité.

[Guiguiabloc]

Ajout de la fonction holidayall (retourne un json sur la date (maintenant ou une date spécifiée) contenant férié, week-end et vacances scolaires (zone à spécifier)

C'est cool ça, y'a qu'a demander...
Bravo et merci pour le boulot et la réactivité.

avec plaisir

[Guiguiabloc]

Une idée, je ne sais pas si elle est valable, j'utilise aussi l'alerte meteo qui a ete developpé je ne sais plus par qui ici... (désolé) est ce que ce ne serait pas intéressant d'agréger aussi ce type de developpement au sein de cette api ??

Je pense que tu parles du fichier xml de @fabmaurel http://www.planete-domotique.com/blog/2014/01/03/la-vigilance-meteo-dans-votre-box-domotique-evolue/comment-page-1/

Je viens de lui demander l'autorisation d'utiliser son fichier pour l'api, j'attends sa réponse