Skip to content

Commit

Permalink
Documenter comment ajouter une nouvelle API (#1246)
Browse files Browse the repository at this point in the history
  • Loading branch information
DorineLam authored Sep 19, 2023
1 parent 48ec6fe commit f3cbf17
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,20 @@ Les fournisseurs, de leur côté, ont avec ce catalogue un moyen simple de faire

## Fournisseur d'API ? Envie de référencer une nouvelle API ?

### 1- Contacter le service
Veuillez prendre attache avec l'équipe en complétant le formulaire suivant :
[👉 Ajoutez votre API](https://api.gouv.fr/nouvelle-api) !

### 2- Ajouter son API dans le code

**Créer une fiche métier ([exemple](https://api.gouv.fr/les-api/api-particulier)) :**
- Rdv dans le dossier [_data/api](https://github.com/betagouv/api.gouv.fr/tree/master/_data/api).
- Y ajouter un fichier `api-nom-de-la-nouvelle-api.md`

**Ajouter un swagger qui apparaîtra [ici](https://api.gouv.fr/documentation) :**
- Dans la fiche métier, complêter le champ `doc_tech_link` avec un lien vers un swagger en json ou yaml qui est hébergé où vous le souhaitez pour être mis à jour le plus souvent possible.
- En ajoutant ce lien dans la fiche métier, votre swagger apparaîtra automatiquement dans API.gouv.

## Comment ça marche ?

### Prérequis
Expand Down

0 comments on commit f3cbf17

Please sign in to comment.