---
title: Importation d’OpenAPI / Swagger
slug: importation-dopenapi-swagger
description: Découvrez comment exploiter la puissance de l’importation OpenAPI dans Archbee pour la documentation de produits destinée aux développeurs. Découvrez les avantages, les versions prises en charge, les méthodes d’authentification, la pré‑population des para
docTags: 
createdAt: 2021-10-29T07:42:12.000Z
---

## Pourquoi utiliser l’import OpenAPI?

Si votre produit est conçu pour des développeurs ou si votre produit possède une API, vous avez besoin d’une excellente documentation produit — sinon, vous ne pourrez pas atteindre efficacement les développeurs.

Une fois que vous importez votre fichier OpenAPI, Archbee le lira et le convertira en une belle interface utilisateur et le rendra prêt à être :

- **Partagé publiquement **(sur un domaine personnalisé) 
- **En interne** avec vos collègues et équipes

Une fois importé, vous pouvez synchroniser, mettre à jour et tester votre OpenAPI. Consultez plus de détails dans les sections ci-dessous.

## Règles et paramètres par défaut

:::hint{type="info"}
Les fichiers OpenAPI importés ne peuvent pas être modifiés manuellement dans Archbee.

Pour mettre à jour et maintenir votre OpenAPI, consultez nos [options de synchronisation](docId\:wogZa8DoaFMHVe1Scpd9-)
:::

### Versions OpenAPI prises en charge :

Archbee prend actuellement en charge l’importation des versions OpenAPI suivantes :

1. Version 2.0 et 2.0.XX
2. Version 3.0 et 3.0.XX
3. Version 3.1 et 3.1.XX

### Méthodes d’auth prises en charge

Archbee prend actuellement en charge les méthodes d’auth suivantes :

1. [Authentification Basic](https://swagger.io/docs/specification/authentication/basic-authentication/)
2. [Clés API](https://swagger.io/docs/specification/authentication/api-keys/)
3. [Authentification Bearer](https://swagger.io/docs/specification/authentication/bearer-authentication/)

Si vous importez des fichiers OpenAPI avec d’autres méthodes d’auth, ils seront importés correctement, et la méthode d’auth sera ignorée.

Cela signifie que vous bénéficierez de toute l’expérience OpenAPI d’Archbee, **sauf **la fonctionnalité Try It!, si votre endpoint nécessite une méthode d’auth qui ne figure pas dans la liste ci-dessus.

### Autres

1. Si vous définissez un paramètre « **par défaut** » dans votre OpenAPI et que vous lui attribuez une valeur, l’exemple de code et la boîte de paramètres seront automatiquement préremplis avec cette valeur.

   Cela permet à vos utilisateurs ou clients de tester votre API avec [Essayez-le !](docId\:OWk75J95C6o7V3q87ogkW) sans avoir à mettre à jour tous les paramètres requis.

2. Si vous définissez un paramètre « **exemple** » dans votre OpenAPI, la valeur d’exemple sera affichée sur le côté gauche juste sous le paramètre API.

   Cela permet à vos utilisateurs d’identifier facilement le type d’entrée requis pour ce paramètre spécifique.

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/fCN8X5XLW-WFI9W1yvi3K_body-light.png)

## Comment cela fonctionne-t-il?

::::WorkflowBlock
:::WorkflowBlockItem
Importez votre fichier OpenAPI à l’aide de **Importer du contenu** :

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/ZIM8Bq-VEqGvv_aHHjArO_import-content-light.png)

Ou utilisez l’option **Importation** depuis chaque espace :

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/0w0sHacVm8l8N_AFkF4yf_import-option-light.png)

Ou synchronisez vos fichiers OpenAPI directement depuis votre dépôt [GitHub](docId\:fS1vd6c9fHGu7YrsCT4Qr) .

Avec l’intégration [Integration Github](docId\:fS1vd6c9fHGu7YrsCT4Qr) Archbee, vous pouvez ajouter et synchroniser vos fichiers OpenAPI directement depuis votre dépôt.
:::

:::WorkflowBlockItem
Prévisualisez et [test](docId\:OWk75J95C6o7V3q87ogkW) votre OpenAPI importé

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/DsF_NDr8yoe62d13qJDP6_test-it-light.png)

Prévisualisez et testez votre OpenAPI nouvellement importé avec la fonctionnalité [API Essayez‑le !](docId\:OWk75J95C6o7V3q87ogkW).
:::

:::WorkflowBlockItem
**Publiez** ou **partagez-le** avec vos collègues ou vos clients !

Publiez-le dans Preview ou sur un Custom Domain et rendez-le accessible à vos collègues, équipes ou utilisateurs. 

Si vous souhaitez protéger le contenu et ne le partager qu’avec certains utilisateurs, consultez nos options [Contrôles d’accès public](docId:8J6DjoIFXpjGKybANdgq_) pour les portails publiés.
:::

:::WorkflowBlockItem
Maintenez-le, synchronisez-le et configurez-le :

1. [Synchroniser manuellement](docId\:wogZa8DoaFMHVe1Scpd9-)
2. [Synchroniser automatiquement via API](docId\:wogZa8DoaFMHVe1Scpd9-)
3. [Changer la langue du code d’exemple](docId\:wogZa8DoaFMHVe1Scpd9-)
:::
::::

## Voici une vidéo montrant le fonctionnement

::embed[]{url="https://youtu.be/LQ3nEGCcdKg"}