Skip to content

Liste les API disponibles au sein de l'administration française

License

Notifications You must be signed in to change notification settings

jpmoreux/api.gouv.fr

 
 

Repository files navigation

api.gouv.fr

api.gouv.fr catalogue les APIs 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

Prérequis

Cette application utilise Next.js.

  1. Installer les dépendances
npm i
  1. Copier le fichier de configuration
cp .env.sample .env
  1. Lancer le serveur de développement
npm run dev

Par défaut, il écoutera sur le port 3000, pour changer, utiliser npm run dev -p 4242.

Afin de configurer le projet correctement, il est conseillé de créer un fichier .env avec les variables d’environnement nécessaires à l’application.

.env permet de persister les variables d’environnement de développement dans un fichier plutôt que de les définir dans le shell, mais les deux fonctionnent. Cela fonctionne avec dotenv et next-runtime-dotenv.

Déploiement

Production

Cette application utilise Next.js.

  1. Installer les dépendances
npm i
  1. Générer les bundles de production
npm run build
  1. Lancer le serveur de production
PORT=3000 npm start

Développement

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

About

Liste les API disponibles au sein de l'administration française

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 72.6%
  • JavaScript 15.2%
  • CSS 12.2%