API de DataService Studio - DataWorks - Centre de documentation Alibaba Cloud

Data Map vous permet de rechercher des API DataService Studio dans tous les espaces de travail de votre locataire, ce qui facilite leur découverte.

Page de recherche d'API

Accédez à la page Data Map.

Connectez-vous à la console DataWorks. Dans la région cible, cliquez sur Data Governance > Data MapData Governance > Data Map dans le volet de navigation de gauche. Sur la page qui s'affiche, cliquez sur Go to Data Map.
Au-dessus de la zone de recherche, sélectionnez la catégorie API.

Le menu déroulant de type de recherche, situé à gauche de la barre de recherche, contient trois groupes : Code, API et Dataset. Sélectionnez API dans le groupe API.

Rechercher une API

Dans la zone de recherche sous la catégorie API, saisissez des mots-clés tels que API ID, APIPath, API Name ou API Description.

Lorsque vous saisissez un mot-clé, une liste déroulante affiche les 10 API correspondantes les plus pertinentes.
Si l'API recherchée ne figure pas dans la liste déroulante, cliquez sur Search pour afficher toutes les correspondances.
Dans le volet de gauche, filtrez les résultats de recherche par API Type, Workspace ou Owner.
Une fois que vous avez trouvé l'API cible, cliquez dessus pour accéder à la page des détails. Pour plus d'informations, consultez Afficher les détails de l'API.

Détails de l'API

La page des détails de l'API fournit les informations Basic Information, Technical Information, Parameter Information, Sample Response et Instructions. Lorsque l'API est en mode Script Mode, l'onglet supplémentaire Code s'affiche également.

La page des détails de l'API est divisée en trois zones : la zone ① en haut affiche le nom de l'API, sa description et le point d'entrée pour modifier l'API. La zone ② dans le panneau de gauche montre les informations de base et techniques de l'API. La zone ③ dans le panneau de droite utilise des onglets pour présenter des contenus détaillés tels que les informations sur les paramètres, les exemples de réponse, les informations de lignage et les notes d'utilisation. Le tableau suivant décrit chaque zone.

Zone	Description
①	Cliquez sur Edit API pour ouvrir la fenêtre de modification dans l'espace de travail de l'API. Pour plus d'informations, consultez Test, publication et gestion des versions d'une API et Enregistrer un service d'API externe. Remarque Si votre compte n'est pas membre de l'espace de travail de l'API, contactez le propriétaire de l'espace de travail et demandez-lui d'ajouter votre compte en tant que membre avec le rôle Developer. Pour plus d'informations, consultez Gérer les autorisations sur les services au niveau de l'espace de travail.
②	Cette zone affiche les informations suivantes sur l'API : Basic Information : comprend des détails tels que les Views, le Number of Calls, l'API ID, le Workspace, le Owner, la date de Created At, la date de Last Updated et la Description. Technical Information : comprend des détails tels que le API Type, la Request Method, le Response Type, le Data Source Type, le Data Source Name et le Table Name.
③	Cette zone affiche les informations suivantes sur l'API : Parameter Information : affiche les Request Parameters et les Response Parameters de l'API. Request Parameters : comprend les détails des Common Request Parameters et des API Request Parameters, y compris le Parameter Name, le Parameter Type, la Parameter Position, la Sample Value, la Default Value, la Description et le Label. Response Parameters : comprend les détails des Common Response Parameters et des API Response Parameters, y compris le Parameter Name, le Parameter Type, la Sample Value et la Description. Sample Response : avant de publier une API, si vous la testez et sélectionnez Save the correct response example automatically pendant le test, l'exemple de réponse est mis à jour en fonction des résultats du test. Pour plus d'informations, consultez Tester une API. Le contenu et la structure de la Sample Response illustrent le format de réponse de l'API. Lineage Information : affiche le lignage complet des données entre les tables de données, les API et les applications. Le lignage des données en amont pour les API DataService Studio prend en charge les types de source de données suivants : Hologres, MySQL, PostgreSQL, SQL Server, Oracle, AnalyticDB for MySQL 3.0 et AnalyticDB for PostgreSQL. Remarque Une API Generation est créée en encapsulant une source de données ou une table. Par conséquent, son lignage de données inclut les tables de données, l'API et les applications. Une Register API est créée en encapsulant une adresse backend. Par conséquent, son lignage de données inclut uniquement l'API et les applications. Le lignage des données est généré et mis à jour selon un cycle T+1. Instructions : vous pouvez Edit les notes ou View Versions pour consulter les modifications historiques. Code : cet onglet n'apparaît que lorsque l'API est en mode Script Mode. Il vous permet d'afficher le code de requête personnalisé (tel que SQL) écrit par le développeur. L'onglet n'est pas affiché pour les autres types d'API (API en mode assistant, API enregistrées ou API de service orchestré) ; pour les API en mode assistant, vous pouvez consulter le SQL dans l'éditeur de développement d'API DataService. Remarque Si vous localisez une API en mode script en recherchant un extrait de code dans la zone de recherche globale de Data Map, le système accède automatiquement à l'onglet Code.