Skip to content
Liste les API disponibles au sein de l'administration française
Branch: master
Clone or download
rdubigny Merge pull request #331 from betagouv/Anna-Livia-patch-1
Indique un moyen de contacter l'ANTS
Latest commit 64f5118 Feb 28, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Migrate to Circle CI 2.0 Sep 25, 2018
_api
_data
_includes Add options to allow future API ranking. Start woking on APIs. Sep 26, 2018
_layouts
_sass
_service
_sources Remove left padding in logo Jul 5, 2016
api/v1
css
img
js
.gitignore
.ruby-version
404.html Drop site.baseurl prepend Oct 8, 2016
CNAME Create CNAME Feb 21, 2019
CONTRIBUTING.md Finish migrating every other APIs Sep 27, 2018
Dockerfile
Gemfile
Gemfile.lock
LICENSE
Procfile
README.md
_config.yml
api-gouv.yml Finish migrating every other APIs Sep 27, 2018
app.json
apropos.md
contact.md
docker-compose.yml add docker + docker-compose Mar 8, 2016
index.html
services.html Ajoute la page service Nov 23, 2018

README.md

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 !

Sous-domaines

Le nom de domaine api.gouv.fr héberge un catalogue d'API et de services les réutilisant.

Les sous-domaines en *.api.gouv.fr hébergent les API cataloguées sur api.gouv.fr et maintenues par la DINSIC.

Installation locale

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

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

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

  • Utiliser Jekyll directement.
  • 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.5.1
  • bundler. La commande a lancer est : gem install bundler

Commandes

  • bundle install pour installer toutes les dépendances nécessaires
  • bundle exec jekyll serve pour lancer un serveur de développement. Il suffit de se rendre sur l'URL indiquée à l'exécution de la commande.
  • bundle exec jekyll build pour générer le site dans le répertoire _site.
  • bundle update pour mettre à jour les dépendances et le Gemfile.lock

Docker

Dépendances

Commandes

  • docker-compose up. Il suffit de se rendre sur l'URL indiquée à l'exécution de la commande.

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. Le compte utilisé est le compte de Thibaut Géry

You can’t perform that action at this time.