1. Importer des documents API

Saisie de fonction : Application de gestion d'API / sélectionner un projet / menu document API / cliquer sur le bouton déroulant à côté du bouton "+ API" / sélectionner "Importer API"

Eolink offre la fonction d'importer des documents API existants en un clic et prend en charge plusieurs formats de produits. Il est souvent utilisé dans des scénarios où les données d'anciens projets ou d'anciens logiciels doivent être migrées après la création d'un nouveau projet.

Les formats de produit actuellement pris en charge sont les suivants :

Formats de produit pris en charge	Soutien	L'extension du fichier importé
Gestion de la R&D de l'API Eolinker	soutenir pleinement	.json
Facteur V2.1	Prend en charge l'importation des informations de base de l'API, les données de l'API avec plus de 10 niveaux de regroupement ne seront pas importées	.json
fanfaronnade V2	Prise en charge de l'importation des informations de base de l'API	.json
fanfaronnade V3	Prise en charge de l'importation des informations de base de l'API	.json
Jmètre	Prise en charge de l'importation des informations de base de l'API	.jmx
Structure	Prise en charge de l'importation des informations de base de l'API	.json
APIPost	Prise en charge de l'importation des informations de base de l'API	.Maryland
apiDoc	Prise en charge de l'importation des informations de base de l'API	.json/.js
Apifox	Prise en charge de l'importation des informations de base de l'API	json
CHEVEUX	Prise en charge de l'importation des informations de base de l'API
RAP	Prise en charge de l'importation des informations de base de l'API	.json
RAP2	Prise en charge de l'importation des informations de base de l'API	.json
PROTO2	Prise en charge de l'importation des informations de base de l'API	.proto
PROTO3	Prise en charge de l'importation des informations de base de l'API	.proto

1. Entrez dans la fenêtre de l'API d'importation selon le chemin d'entrée de la fonction ci-dessus.

2. Sélectionnez le format de type de données d'importation correspondant.

3. Configurer les règles d'importation

Description des options

1) Importez l'API dans le groupe suivant : sélectionnez le groupe d'API correspondant

2) Définissez le statut du document API nouvellement généré sur : Vous pouvez définir le statut correspondant du document API importé

3) Définissez le statut du document d'API modifié sur : si le document d'API a changé de statut, le statut du document spécifié peut être mis à jour

4) Définissez le numéro de version du document d'API nouvellement généré ou modifié sur : Vous pouvez définir le numéro de version d'API spécifié pour le document d'API importé

4. Attendez que la tâche d'importation soit terminée

Après avoir défini les règles de configuration de l'importation, cliquez sur OK pour afficher une invite de réussite et la colonne de droite indique que ma file d'attente de tâches est en cours. Lorsque l'état indique qu'elle est terminée, l'importation est réussie.

Enfin, actualisez la page et vous pouvez voir les données d'API importées comme indiqué dans la figure

2. Exporter des documents

Exporter la documentation de l'API

Vous pouvez exporter la documentation de l'API du projet vers une variété de formats hors ligne pour un partage facile avec des personnes extérieures à l'équipe.

Il existe 3 méthodes d'exportation :

Exporter tous les documents API du projet
Exporter les documents API dans le groupe
Exporter le document d'API spécifié

Exporter tous les documents API du projet

1. Dans la gestion de projet sur la colonne de gauche, sélectionnez les paramètres de projet du menu de second niveau, puis cliquez sur "Exporter le projet" dans d'autres opérations en bas.

L'exportation de projets prend en charge les formats suivants :

Données du projet Eolink Apikit
Données liées à l'API Eolink Apikit
HTML
Mot
PDF
Exceller
Réduction
JSON fanfaron
Swagger YAML

La différence entre les données du projet Eolink Apikit et les données liées à l'API Eolink Apikit est que la première contient des données liées à l'API et des données publiques supplémentaires au niveau du projet telles que les codes de statut, les documents de projet, les environnements et les structures de données, tandis que la seconde ne prend en charge que l'API. documents, cas de test, Advanced Mock et autres données.

2. La première option Données du projet Eolink (.json) consiste à exporter toutes les données API du projet en cours et cliquez sur OK pour effectuer l'opération d'exportation comme indiqué sur la figure

3. Les autres formats afficheront le bouton Suivant, cliquez sur Suivant pour passer au contenu d'exportation sélectionné

Exporter les documents API dans le groupe

1. Cliquez sur API dans la colonne de gauche, sélectionnez le groupe à importer et cliquez sur la liste déroulante pour sélectionner l'API d'exportation

Le groupe d'exportation prend en charge les formats suivants :

Applications Eolink
Mot
PDF
Exceller
Réduction

Remarque : La version gratuite du produit ne prend en charge que l'exportation du format Eolink Apikit, et les autres formats doivent être mis à niveau vers la version professionnelle du produit.

2. Cliquez sur Suivant pour sauter pour sélectionner le contenu exporté comme indiqué dans la figure

Exporter le document d'API spécifié

1. Cliquez sur API dans la colonne de gauche, sélectionnez le groupe à importer ou cliquez sur toutes les API, puis cliquez sur le bouton d'opération par lots sous l'onglet de la liste des API à droite, comme indiqué sur la figure.

2. Sélectionnez les données API à exporter et cliquez sur le bouton d'exportation comme indiqué dans la figure

Les formats suivants sont pris en charge pour l'exportation de documents d'API de pointage :

Applications Eolink
Mot
PDF
Exceller
Réduction

Remarque : La version de base du produit ne prend en charge que l'exportation du format Eolink Apikit, et les autres formats doivent être mis à niveau vers la version professionnelle ou entreprise du produit.

3. Cliquez sur Suivant pour sauter pour sélectionner le contenu exporté

Choisissez quoi exporter

1. Si vous choisissez d'exporter tous les documents API du projet, la colonne de gauche affiche le groupement d'API de filtre et la colonne de droite affiche les conditions de filtre de sélection, comme indiqué dans la figure.

2. Si vous choisissez d'exporter les documents API dans le groupe, les conditions du filtre de sélection seront affichées comme indiqué dans la figure

3. Si le document d'API spécifié est exporté, les conditions de filtre seront affichées et seul le contenu exporté supplémentaire sera affiché comme indiqué dans la figure

Description du champ de filtre

1) Filtrer les balises API : vous pouvez filtrer les données des balises API spécifiées

2) Filtrer les balises API : vous pouvez filtrer les données API avec et sans étoiles

3) Filtrer l'état de l'API : vous pouvez filtrer l'état de l'API spécifié

4) Contenu d'exportation supplémentaire : vous pouvez filtrer des informations telles que des exemples de retour d'API et des descriptions détaillées d'API (execl et Swagger ne prennent pas en charge cette option)

5) Environnement d'exportation : vous pouvez exporter l'environnement de projet spécifié (Eolink ne prend pas en charge la modification des options)

dernière étape

1. Après avoir cliqué sur OK, une invite de réussite s'affiche et la colonne de droite indique que l'état de ma file d'attente de tâches est en cours et réussi, puis vous pouvez cliquer pour télécharger sur le local

Carnet d'autoformation Apikit : importer et exporter des documents