Data Map memungkinkan Anda mencari dan memeriksa API DataService Studio apa pun di seluruh ruang kerja dalam penyewa Anda—mulai dari metadata dasar hingga parameter, respons contoh, alur data, dan catatan penggunaan.
Untuk mengedit API dari halaman detailnya, akun Anda harus menjadi anggota ruang kerja yang memiliki API tersebut dan memiliki role developer. Jika tidak, hubungi administrator ruang kerja. Untuk detailnya, lihat Mengelola izin pada layanan tingkat ruang kerja.
Peta Data Terbuka
-
Masuk ke Konsol DataWorks.
-
Pada bilah navigasi atas, pilih Wilayah Anda.
-
Pada panel navigasi kiri, pilih Data Governance > Data Map.
-
Pada halaman yang muncul, klik Go to Data Map.
-
Pada halaman utama Data Map, pilih API dari daftar drop-down Type di bawah kotak pencarian.
Cari API
Data Map melakukan pencarian pada bidang-bidang berikut:
| Bidang yang dapat dicari | Contoh |
|---|---|
| ID API | Identifikasi numerik |
| Path API | Path URL dari endpoint API |
| Nama API | Nama tampilan API |
| Deskripsi API | Kata kunci dari teks deskripsi |
Untuk mencari API:
-
Masukkan kata kunci di kotak pencarian. Sepuluh API pertama yang sesuai akan muncul di daftar drop-down sebagai hasil awal.
-
Jika API yang Anda butuhkan tidak ada di daftar drop-down, klik Search. Semua API yang sesuai dengan kata kunci akan ditampilkan.
-
Untuk mempersempit hasil, gunakan filter di sebelah kiri: API Type, Workspace, dan Owner.
-
Klik nama API untuk membuka halaman detailnya.
Lihat detail API
Halaman detail API dibagi menjadi tiga area.
Area 1 — Akses edit
Klik Edit API untuk membuka tab konfigurasi API di ruang kerjanya dan mengeditnya. Untuk informasi lebih lanjut, lihat Publikasikan API dan Daftarkan API.
Area 2 — Informasi dasar dan teknis
| Bagian | Bidang |
|---|---|
| Informasi dasar | Jumlah tampilan, jumlah panggilan, ID API, ruang kerja, pemilik API, waktu pembuatan, waktu pembaruan, deskripsi API |
| Informasi teknis | Tipe API, metode permintaan, tipe respons, tipe sumber data, nama sumber data, nama tabel |
Area 3 — Parameter, respons contoh, alur data, dan catatan penggunaan
Informasi parameter
Tab Parameter Information memiliki dua subtab:
-
Request Parameters — Menampilkan daftar parameter permintaan umum dan aplikasi, termasuk nama parameter, tipe parameter, lokasi parameter, nilai contoh, nilai default, deskripsi, dan tag.
-
Response Parameters — Menampilkan daftar parameter respons umum dan aplikasi, termasuk nama parameter, tipe parameter, nilai contoh, dan deskripsi.
Respons contoh
Menampilkan struktur hasil yang dikembalikan oleh permintaan API. Respons contoh diperbarui secara otomatis saat Anda memilih Save the correct response example automatically selama pengujian sebelum publikasi. Untuk informasi lebih lanjut, lihat Uji API.
Silsilah
Menampilkan alur data lengkap melalui tabel, API, dan aplikasi.
Sumber data leluhur yang didukung: Hologres, MySQL, PostgreSQL, SQL Server, Oracle, AnalyticDB for MySQL 3.0, dan AnalyticDB for PostgreSQL.
| Tipe API | Cakupan alur data |
|---|---|
| Generated API | Tabel data → API → aplikasi |
| Registered API | API → aplikasi saja |
Informasi alur data dihasilkan dan diperbarui dengan penundaan satu hari.
Catatan penggunaan
Klik Edit untuk memperbarui catatan penggunaan API, atau klik View Versions untuk menelusuri riwayat versi.