api.gouv.fr

api.gouv.fr catalogue les API offertes par les administrations centrales, les collectivités territoriales, les établissements publics… Chaque API est associée à une courte description fonctionnelle, une documentation technique, les modalités d'accès, d'éventuelles ressources supplémentaires et surtout des liens vers les services qui l'utilisent.

Public visé

api.gouv.fr s'adresse avant tout aux créateurs de services, les consommateurs d'API. Pour cela, nous facilitons la découverte, la compréhension et l'accès aux API et à leurs producteurs.

Les fournisseurs, de leur côté, ont avec ce catalogue un moyen simple de faire connaître leurs API.

Fournisseur d'API ? Ajoutez votre API !

Réutilisateur d'API ? Ajoutez votre service !

Installation locale

Nous utilisons docker, il vous faut donc installer une version au moins égale de :

Pour récupérer les sources :

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

Pour lancer le serveur en mode dev :

docker-compose up

Puis il suffit de se rendre sur http://localhost:4000

Déploiement

Production

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

Développement

Chaque pull request est déployé dans des review app sur Heroku