Skip to content

Latest commit

 

History

History
82 lines (44 loc) · 3.4 KB

README.md

File metadata and controls

82 lines (44 loc) · 3.4 KB
Raw

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 fonctionnelles, une documentation technique, les modalités d'accès, d'éventuelles ressources supplémentaires et surtout des 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/sgmap/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.2.3
  • bundle. La commande a lancer est : gem install bundle

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/sgmap/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