Api.gouv.fr

Le site public listant les API au sein du Système d'Information des Services Publics Français

Public visé

1. Administrations (Collectivités, Ministères, etc) souhaitant fournir des services aux citoyens français.
2. Structure de droit privé (entreprise, association…) souhaitant fournir des services.
3. Administrations proposant des données au travers d'API.

Fournisseur d'API ? Ajoute ton API !

Réutilisateurs d'API ? Ajoute ton service !

api.gouv.fr

Ce nom de domaine héberge :

• une présentation des différentes API proposées par l'État et les administrations
• une présentation des services utilisant des API présentées

Installation locale

Il est nécessaire de récupérer les sources avec la commande :

git clone https://github.com/sgmap/api.gouv.fr.git
cd api.gouv.fr

Il existe ensuite deux manières de lancer le site sur sa machine :

• Il est possible d'utiliser Jekyll directement
• Il est possible d'utiliser Docker

Ces deux méthodes sont indépendantes et détaillées ci-dessous.

jekyll

Le site utilise Jekyll, un générateur de site statique en Ruby.

Dépendances

• Ruby. Il est recommandé d'utiliser un système de virtualisation comme RVM ou RbEnv. La version à utiliser est : 2.2.3
• la gem github-pages qui contient jekyll ainsi que les plugins sont disponibles sur github : gem install github-pages -v 2.4.8

Commandes

• jekyll serve pour lancer un serveur de développement. Il suffit de se rendre sur l'URL indiquée
• jekyll build pour générer le site dans le répertoire _site

Docker

Dépendances

• Docker (version > 1.10)
• Docker-compose (version > 1.6)

Commandes

• docker-compose up, Il suffit de se rendre sur l'URL indiquée

Déploiement

Pour déployer ce site, il suffit de pousser les modifications vers la branche gh-pages sur github.com/sgmap/api.gouv.fr. Cette branche étant protégée, il convient de faire des pull requests car le projet utilise github flow.