Migration api.data.gouv.fr

[geoffreyaldebert]

Après discussions entre les équipes api et data, il semble qu'une piste sérieuse pourrait être l'intégration des APIs référencées dans api.gouv.fr au sein de data.gouv.fr.

Des évolutions sont néanmoins nécessaires. Nous les listons ci-dessous :

• [ ] Intégrer les APIs au sein de data.gouv.fr en tant que jeux de données de type API
• [ ] adopter un formalisme et une visualisation particulière permettant de rendre compte des spécificités liées aux APIs (par exemple, les infos de disponibilité, de rate limiting, de swagger etc.)
• [ ] Intégrer les Guides / Cas d'usages d'api.gouv.fr au sein de data.gouv.fr
• [ ] Cross-référencer les guides et les APIs au sein de data.gouv.fr
• [ ] Développer une interface permettant de lire un swagger externe sur data.gouv.fr (pourra servir également pour l'exposition des données hydra)
• [ ] Développer une interface permettant d'orienter les différents types de public d'une API comme le fait api.gouv.fr - exemple
• [ ] Permettre de pouvoir chercher facilement au sein de ces APIs. Cela nécessitera donc peut-être l'ajout d'une métadonnée mise en avant API pour ne pas noyer ces APIs éditorialisées des autres (surtout quand on aura les APIs hydra)
• [ ] Editorialiser la plateforme data.gouv.fr pour trouver facilement les infos sur les APIs

Un premier test a été fait sur demo.data.gouv.fr. Les APIs ont toutes été basculées en tant que Jeux de données (datasets) de type API (voir ici) et les Cas d'usages ont également été basculés en tant que posts data.gouv.fr (voir par exemple ici)

• Il manque cependant le formalisme des APIs même si l'ensemble des informations portées sur api.gouv.fr a été intégré en backend via les métadonnées extras des jeux de données (voir exemple). Une passe UX et UI est ici nécessaire.
• Le swagger est rerouté vers api.gouv.fr qui sait lire ce type de ressource. Cette fonctionnalité n'est pas développé sur data.gouv.fr
• Les infos concernants les accès pour les différents publics sont également stockés en extras mais il n'y a pas d'interface pour les afficher à l'heure actuel.
• il faudra ré-identifier les producteurs et les attribuer dans les jeux de données. Pour l'instant, une orga apigouvtest sert de producteur pour toutes ces APIs. Cela ne devrait pas être trop difficile.

J'ai commencé un notebook jupyter pour la migration des données ici

[geoffreyaldebert]

@agarrone @maudetes c'est un premier défrichage, il faudra qu'on itère tous ensemble.

[agarrone]

Top merci pour ce travail !

[geoffreyaldebert]

@Haelle