[API] Besoins

[leosw]

Salut à tous,

J'ai fait un petit dessin des besoins de l'API, voilà un beau petit dessin :



Si vous voulez la modifier, il faut aller sur la framindmap ici et cliquer en haut à droit sur Ouvrir, le fichier à ouvrir est téléchargeable ici.

Léo

[Dominique]

Pour Opéra, changer à Invalides, mais je vois pas le poinçonneur des Lilas ?
A part ça, il manque l'export commentaire avec texte, photo, auteur, date et le service de détermination de massifs à partir de la position géographique dont je me sert dans chemineur.

[leosw]

il manque l'export commentaire avec texte, photo, auteur, date

Pour moi c'est dans l'export de points, quand on sélectionne un nombre supérieur à zéro de commentaires, mais il peut en effet y avoir une option pour savoir si on inclut l'image dans le json (très lourd) ou seulement un lien vers l'image hébergée sur wri.

le service de détermination de massifs à partir de la position géographique

Là je ne comprends pas trop ce que tu demandes à l'API d'exporter... On peut ajouter une branche dans les requêtes qui s'appellerait "Conversion long/lat vers massif" et qui pour une coordonnées, donne la liste des massifs incluant ce point en json et/ou csv avec nom, id et autre du massif.

Il faudrait penser à mettre au propre une génératon de table avec liste des massifs et id des massifs de manière à pouvoir sélectionner. Et de même avec toutes les combinaisons d'informations complémentaires en fonction du type de point.

[sly]

il manque l'export commentaire avec texte, photo, auteur, date

Pour moi c'est dans l'export de points, quand on sélectionne un nombre supérieur à zéro de commentaires, mais il peut en effet y avoir une option pour savoir si on inclut l'image dans le json (très lourd) ou seulement un lien vers l'image hébergée sur wri.

Dans un premier temps, je suis d'accord avec léo, le besoin d'exporter les commentaires n'existe que comme complément aux points. C'est à dire quelque chose comme : "API, je veux le point n°550 avec ses commentaires"
Toutefois, on peut imaginer avoir un appel du genre :"API, je veux tous les commentaires de l'auteur X" ou "API, je veux tous les commentaires se rapportant à des points dans le massif Y" ou encore, "je veux tous les commentaires des 4 derniers jours" mais je pense que l'on peut garder ça pour une évolution future de l'API sauf si (voir mon message suivant)

le service de détermination de massifs à partir de la position géographique

D'accord avec léo, cette demande est loin d'une API d'exportation de notre base !
Cela ne concerne même pas des points de wri vu que tu dis "position géographique".

Si jamais on doit la faire exister (pour faire plaisir à chemineur.fr qui n'a pas la chance d'avoir postgis) je défend le point de vue de faire ça en dehors de l'api principale, une api "underground" que l'on pourrait appeler....

Code : Tout sélectionner

http://www.refuges.info/api-pour-chemineur-qui-n-a-pas-postgis?dans-quel-massif-il-est-ce-point=45.5664,6.5879

[sly]

Pour léo : joli araignée ton truc, que je le prend pour ce que tu as dis que c'était : "l'expression des besoins"

Ce qui est très bien décrit. Manque peut-être :
- ajout/modification
Mais comme on a dit qu'on gardait ça pour plus tard, cette expression des besoins me va.

Par contre pour transposer ça en API, on a l'impression que chaque branche que tu as dessiné correspond à un "type d'appel" et perso, je ne ferais pas comme ça.

Je vois assez bien, une API, dont les appels primaires sont ceux de nos "objets" ou de nos type de données, c'est à dire :
L'appel "point" qui renvoi des points
L'appel "polygone qui" renvoi des polygones
L'appel "commentaires" qu'on peut soit laisser de coté pour l'instant (sauf si on préfère que l'appel "point" ne renvoie pas des commentaires et que pour construire une fiche il faudra faire donc 2 appels :
1 pour obtenir le point
1 autre pour obtenir les points du commentaire )


bbox, c'est une condition de récupération des points
recherche (avec critères) aussi une condition de récupération des points
nouveauté est une conditions de récupération de points et de commentaires

[Dominique]

... il peut en effet y avoir une option pour savoir si on inclut l'image dans le json (très lourd) ou seulement un lien vers l'image hébergée sur wri.

Mumm. Je ne vois pas des images dans une API. Plutôt le lien

le service de détermination de massifs à partir de la position géographique

D'accord avec léo, cette demande est loin d'une API d'exportation de notre base !
Cela ne concerne même pas des points de wri vu que tu dis "position géographique".

Si jamais on doit la faire exister (pour faire plaisir à chemineur.fr qui n'a pas la chance d'avoir postgis) je défend le point de vue de faire ça en dehors de l'api principale, une api "underground" que l'on pourrait appeler....

Code : Tout sélectionner

http://www.refuges.info/api-pour-chemineur-qui-n-a-pas-postgis?dans-quel-massif-il-est-ce-point=45.5664,6.5879

Tout à fait. C'est un web service qui utilise la base des polygones et un peu de calcul PHP mais totalement décorrélée des refuges.
Une des raisons qui me fait l'utiliser directement sur le serveur est que je profite instantanément des modifs de polygones.
L'autre est effectivement la non dispo de pgsql sur 1&1 Mais je peux changer

[leosw]

Salut à tous,

- ajout/modification

Oui je suis parti sur API lecture seule, car je n'ai absolument aucune idée de comment sécuriser le truc, et que la solution parfaite est d'empêcher les entrées de l'extérieur. Donc pas d'écriture pour le moment.

Par contre pour transposer ça en API, on a l'impression que chaque branche que tu as dessiné correspond à un "type d'appel" et perso, je ne ferais pas comme ça.

Bein pour moi, j'ai pensé en requête SQL, et chacune des 5 branche a une requête particulière avec des paramètres particuliers. Donc pour tout sortir, il faut 5 requêtes différentes, ce qui correspond à 5 modèles et contrôleurs. Ensuite il faut une vue par format (la vue peut être utilisée plusieurs fois, par exemple pour les bbox ou polygones).

Est-ce que je fonce là dedans où est-ce que faut ajouter quelque chose ou modifier ?

Léo

[sly]

Est-ce que je fonce là dedans où est-ce que faut ajouter quelque chose ou modifier ?

Foncer ?
Oulla, je vais sans doute faire mon rabas-joie, mais avant de pisser du code qu'il faudra peut-être reprendre si on se gourre, je préfère écrire un peu de doc pour qu'on voit quels sont les appels qu'on envisage, ce que ça doit renvoyer et que ceux qui code OL/leaflet/exportation qui seront utilisateur de cette API voit quelles modifications ils devront faire et si les "nouveaux" appels couvrent leurs besoins.

Pour info, voici la xapi d'openstreetmap (cette une API prévue pour la récupération de donnée, pas pour l'édition) que je trouve bien pensé et sur laquelle je voudrais reprendre le principe :
http://wiki.openstreetmap.org/wiki/XAPI

Pas forcément la syntaxe pile poil of course, mais les principes généraux.

Tu à quoi toi en tête comme URL d'appel à l'api pour par exemple :
- récupérer un point (nom, alti, coordonnées, remarques, accès, type, id ?)
- récupérer les commentaires d'un point
- récupérer les points à proximité d'un autre point
- récupérer les points pour affichage dans openlayers, quid des icones ? du nom ?

En sortie :
quel format pour json ? quel format xml ? gml ? kml ?


Perso, ce que j'ai en tête, c'est que cette API remplace /exportations que nous supprimerons alors ensuite, mais peut-être que vous voyez ça autrement ?

[leosw]

Je parlais des besoins, mais il faut encore discuter de petits points, les topics vont fleurir avant de commencer à coder

[sly]

Ha ok !

Alors oui, pour les besoins, j'ai l'impression que tu as tout couvert de l'existant.

Dans "recherche" il n'est pas clair que l'exportation vers kml/kmz/csv/gpx est une forme de "recherche" mais qui aujourd'hui existe et permet un export vers un fichier
http://www.refuges.info/formulaire_exportations/

Pour les "nouveauté", j'ai rien contre, mais ça ne me semble pas urgent (à moins que tu penses à un usage précis ?)

[leosw]

On pourra faire nouveauté en dernier, mais je pense qu'après c'est la même chose, juste un classement par date, donc je ne vois pas la grosse difficulté, mais à faire en dernier oui.

Pour la recherche je n'ai pas tout compris...

Léo

[sly]

Pour la recherche je n'ai pas tout compris...

Je voulais juste dire qu'il manque à l'expression des besoins ça :
http://www.refuges.info/formulaire_exportations/

[leosw]

Pour moi c'est l'exportation groupe->massif. Ça fait la même chose, on donne id des massifs, nombre de points, type de points, et on a une liste de points.

[sly]

ok, ça me va alors si c'est dans la notion de "groupe"

[Dominique]

A noter pour la doc que j'ai ajouté un exportation des massifs en format geoJson pour la carte d'accueil.
http://www.refuges.info/exportations/ma ... at=geojson