API di DataService Studio - DataWorks

Data Map memungkinkan Anda mencari dan menemukan API DataService Studio dari semua workspace dalam tenant saat ini secara efisien.

Pergi ke halaman DataMap untuk mencari API

Buka halaman DataMap.
Masuk ke Konsol DataWorks. Di bilah navigasi atas, pilih wilayah yang diinginkan. Di panel navigasi sisi kiri, pilih Data Governance > Data Map. Pada halaman yang muncul, klik Go to Data Map.
Di halaman utama Data Map, pilih API dari daftar drop-down Type di bawah kotak pencarian.

Cari API

Di kotak pencarian, masukkan kata kunci seperti API ID, API path, API name, atau API description.
Setelah memasukkan kata kunci, 10 API pertama yang sesuai dengan kata kunci akan ditampilkan dalam daftar drop-down sebagai hasil pencarian awal yang disediakan oleh sistem.
Jika tidak dapat menemukan API yang diinginkan dalam daftar drop-down kotak pencarian, klik Cari. Semua API yang memenuhi kondisi filter akan ditampilkan.
Cari API yang diinginkan dengan mengonfigurasi parameter API Type, Workspace, dan Owner yang ditampilkan di sebelah kiri halaman.
Untuk melihat detail API, klik nama API untuk membuka halaman detail API. Untuk informasi lebih lanjut, lihat Lihat detail API.

Lihat detail API

Di halaman detail API, Anda dapat melihat informasi berikut tentang API: basic information, technical information, parameters, sample response, dan usage notes.

Area	Deskripsi
1	Di area ini, Anda dapat mengklik Edit API untuk pergi ke tab konfigurasi API di workspace terkait dan mengedit API. Untuk informasi lebih lanjut, lihat Publikasikan API dan Daftarkan API. null Jika akun login saat ini belum ditambahkan sebagai anggota workspace tempat API tersebut berada, hubungi administrator workspace untuk menambahkan akun tersebut sebagai anggota dan memberikan peran pengembang kepada akun tersebut. Untuk informasi lebih lanjut, lihat Kelola izin pada layanan tingkat workspace.
2	Di area ini, Anda dapat melihat informasi berikut tentang API: Basic Information: Di bagian ini, Anda dapat melihat informasi dasar tentang API, seperti the number of times that the API is viewed, number of times that the API is called, API ID, workspace to which the API belongs, API owner, creation time, update time, dan API description. Technical Information: Di bagian ini, Anda dapat melihat informasi teknis tentang API, seperti API type, request method, return type, data source type, data source name, dan table name.
3	Di area ini, Anda dapat melihat informasi berikut tentang API: Parameter Information: Di tab ini, Anda dapat melihat request parameters dan response parameters dari API. Request Parameters: Di subtab ini, Anda dapat melihat informasi tentang common request parameters dan application request parameters, seperti parameter name, parameter type, parameter location, sample value, default value, description, dan tag. Response Parameters: Di subtab ini, Anda dapat melihat informasi tentang common response parameters dan application response parameters, seperti parameter name, parameter type, sample value, dan description. Sample Response: Jika Anda menguji API dan memilih Save the correct response example automatically selama pengujian sebelum API dipublikasikan, contoh respons diperbarui berdasarkan hasil pengujian. Untuk informasi lebih lanjut, lihat Uji API. Anda dapat melihat hasil yang dikembalikan oleh permintaan API berdasarkan konten data dan struktur data pada tab Sample Response. Lineage: Di tab ini, Anda dapat melihat garis keturunan lengkap dari tabel, API, dan aplikasi. Jenis sumber data berikut dapat digunakan sebagai garis keturunan leluhur dari API saat ini: Hologres, MySQL, PostgreSQL, SQL Server, Oracle, AnalyticDB for MySQL 3.0, dan AnalyticDB for PostgreSQL. null Untuk generated API, API dihasilkan berdasarkan sumber data atau dengan mengenkapsulasi tabel. Garis keturunan API mencakup tabel data, API, dan aplikasi. Untuk registered API, API diperoleh dengan mengenkapsulasi alamat backend. Garis keturunan API hanya mencakup API dan aplikasi. Informasi garis keturunan dihasilkan dan diperbarui dengan a delay of one day. Usage Notes: Di tab ini, Anda dapat mengklik Edit untuk memodifikasi catatan penggunaan API dan View Versions untuk melihat versi historis dari catatan penggunaan API.