Skip to content

Latest commit

 

History

History
133 lines (86 loc) · 9.21 KB

CONTRIBUTING.md

File metadata and controls

133 lines (86 loc) · 9.21 KB
Raw

Améliorer le site public des API des administrations

Ajouter une API

Vous connaissez l’interface GitHub

Ajoutez votre API en un clic 😃

Sinon, offline : créer un nouveau fichier de description dans le dossier _data/api et renseigner les informations en prenant exemple sur un fichier de description existant déjà dans ce dossier.

Nous vous recommandons de :

  • Fournir la documentation au format OpenAPI.
  • Décrire de manière claire et concise les modalités d'accès à l'API (CGU, licence…).
  • Donner des exemples pertinents démontrant des utilisations réelles de l'API.
  • Fournir des statistiques publiques donnant des mesures d'impact (par exemple : nombre de courses de taxi, de pièces justificatives non réclamées…).

Dans le cas d'API fermées :

  • Rendre accessible un environnement « bac à sable » permettant de tester l'API.
  • Automatiser et simplifier autant que possible la procédure d'enrôlement.

Vous souhaitez un accompagnement ?

Contactez nous

Ajouter un service

Vous connaissez l’interface GitHub

Ajoutez votre service en un clic 😃

Sinon, offline : créer un nouveau fichier de description dans le dossier _data/service et renseigner les informations en prenant exemple sur un fichier de description existant déjà dans ce dossier.

Vous souhaitez un accompagnement ?

Contactez nous

Éditer la description d'une API

Modifier le fichier de description de l'API dans le dossier _data/api.

Modifier le contenu éditorial

Rechercher le contenu à modifier et éditer le fichier correspondant.

Ajouter des statistiques d'usage

Il est possible d'afficher des statistiques d'usage de votre API. Par exemple, le nombre de traitements, le nombre d'appels HTTP etc.

Vous devez renseigner une URL où vous mettez à disposition des statistiques d'usage. 2 possibilités s'offrent à vous : renseigner uniquement un chiffre ou mettre à dispostion un objet JSON avec plusieurs clés (plusieurs indicateurs par exemple).

Uniquement un chiffre :

stat:
  # Indique la temporalité de l'indicateur en nombre de jours
  lastXdays: 30
  # L'URL où vous mettez à disposition un chiffre
  url: https://api.gouv.fr/les-api/stats/justificatifs
  # La description de votre statistique
  label: justificatifs papier évités

Un document JSON :

stat:
  # Indique la temporalité de l'indicateur en nombre de jours
  lastXdays: 30
  # L'URL où vous mettez à disposition un document JSON contenant des statistiques
  url: https://api.gouv.fr/les-api/stats
  # La description de votre statistique
  label: justificatifs papier évités
  # La clé du document JSON que vous souhaitez utiliser
  path:
    - justificatifs

Dans le dernier exemple, votre document JSON devrait avoir la structure suivante :

{
  "justificatifs": 42,
  "non_utilise": 1
}

Modifier les exemples de recherches

Mettre à jour la propriété SEARCH_FIELDS dans index.js.

Déploiement

Installation locale

Cette application utilise Next.js.

  1. Installer les dépendances
yarn
  1. Lancer le serveur de développement
yarn dev

Production

Cette application utilise Next.js.

  1. Installer les dépendances
yarn
  1. Générer les bundles de production
yarn build
  1. Lancer le serveur de production
yarn start