DataWorks:Lihat, kelola, dan lakukan operasi batch pada API

Lihat API

1. Masuk ke Konsol DataWorks. Pada bilah navigasi atas, pilih Wilayah yang diinginkan. Di panel navigasi kiri, pilih Data Analysis and Service > DataService Studio. Pada halaman yang muncul, pilih ruang kerja yang diinginkan dari daftar drop-down, lalu klik Go to DataService Studio.

2. Pada halaman Service Development, buka folder Business Flow > API tempat API target berada.

3. Klik kanan nama API tersebut, lalu pilih Details.

   Catatan

   Anda hanya dapat mengklik kanan API dan memilih Details jika API tersebut telah dipublikasikan. Jika API belum dipublikasikan, Anda dapat mengklik Properties di panel kanan halaman konfigurasi API untuk melihat informasi dasarnya.

Kloning API

Anda dapat membuat salinan API dan menyimpannya ke jalur tertentu dalam struktur direktori.

1. Pada halaman Service Development, buka folder Business Flow > API tempat API target berada.

2. Klik kanan nama API tersebut, lalu pilih Clone.

3. Pada kotak dialog Clone API, konfigurasikan parameter-parameter berikut.

   

   Parameter	Deskripsi
   API Name	Nama dapat berisi karakter Tionghoa, huruf, angka, dan garis bawah (_). Nama harus dimulai dengan karakter Tionghoa atau huruf, serta memiliki panjang 4 hingga 50 karakter.
   API Path	Jalur tempat API disimpan, misalnya /user. Jalur API dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-). Jalur harus dimulai dengan garis miring (/) dan tidak boleh lebih dari 200 karakter.
   Description	Tambahkan deskripsi untuk API yang dikloning.
   Destination Folder	Folder tempat API disimpan.

4. Klik Confirm.

Hapus API

Anda hanya dapat menghapus API yang belum dipublikasikan. Jika API telah dipublikasikan, Anda harus membatalkan publikasinya terlebih dahulu sebelum dapat menghapusnya.

1. Batalkan publikasi API jika sudah dipublikasikan. Langkah ini bersifat opsional.

   Jika API Anda belum dipublikasikan, Anda dapat melewati langkah ini.

   1. Pada halaman Service Development, klik Service Management di bilah menu atas. Halaman API Management akan muncul secara default.

      

   2. Pada tab Published APIs, klik Unpublish di kolom Management untuk API tersebut.

   3. Setelah API dibatalkan publikasinya, klik Service Development di bilah menu atas untuk kembali ke halaman Service Development.

2. Pada halaman Service Development, buka folder Business Flow > API tempat API target berada.

3. Klik kanan API yang ingin dihapus, lalu pilih Delete.

   Penting

   Operasi ini tidak dapat dibatalkan. Untuk menjaga keamanan data, lakukan dengan hati-hati.

Mobile API

Anda hanya dapat memindahkan API yang belum dipublikasikan. Jika API telah dipublikasikan, Anda harus membatalkan publikasinya terlebih dahulu sebelum dapat memindahkannya.

1. Batalkan publikasi API jika sudah dipublikasikan. Langkah ini bersifat opsional.

   Jika API Anda belum dipublikasikan, Anda dapat melewati langkah ini.

   1. Pada halaman Service Development, klik Service Management di bilah menu atas. Halaman API Management akan muncul secara default.

      

   2. Pada tab Published APIs, klik Unpublish di kolom Management untuk API tersebut.

   3. Setelah API dibatalkan publikasinya, klik Service Development di bilah menu atas untuk kembali ke halaman Service Development.

2. Pada halaman Service Development, buka folder Business Flow > API tempat API target berada.

3. Klik kanan API yang ingin dipindahkan, lalu pilih Move.

4. Pada kotak dialog Modify File Path, pilih Destination Folder, lalu klik Confirm untuk memindahkan API tersebut.

5. Penting

   Memindahkan API dapat mengubah kelompok tempat API tersebut berada. Hal ini memengaruhi URL pemanggilan API setelah dipublikasikan. Oleh karena itu, pindahkan API yang telah dipublikasikan dengan hati-hati.

Operasi batch untuk API

DataWorks mendukung operasi batch untuk API, seperti mengubah kelompok sumber daya layanan, menyerahkan (submit) API, dan mempublikasikan API. Fitur ini memungkinkan Anda dengan cepat mengganti kelompok sumber daya untuk beberapa API sekaligus dan mempublikasikannya kembali.

1. Pada halaman Service Development, klik ikon di bagian atas struktur direktori di sebelah kiri untuk membuka halaman operasi batch.

   

2. Di bagian atas halaman operasi batch, Anda dapat memfilter API berdasarkan kondisi seperti Business Flow dan Owner.

3. Dari daftar hasil filter, pilih API yang ingin dioperasikan secara batch.

4. Setelah memilih API, pilih operasi batch dari bagian bawah halaman untuk diterapkan.

   Berikut ini menjelaskan hubungan antara operasi batch dan status API:

   Operasi batch	Belum dipublikasikan & Belum diserahkan	Belum dipublikasikan & Sudah diserahkan	Sudah dipublikasikan & Belum diserahkan	Sudah dipublikasikan & Sudah diserahkan
   Modify service resource group
   Submit		Anda tidak dapat menyerahkan API tersebut lagi. Buka halaman pengeditan API dan batalkan versi yang sebelumnya telah diserahkan di Version Control di panel kanan.		Anda tidak dapat menyerahkan API tersebut lagi. Buka halaman pengeditan API dan batalkan versi yang sebelumnya telah diserahkan di Version Control di panel kanan.
   Publish	API harus diserahkan terlebih dahulu sebelum dapat dipublikasikan. Untuk API yang belum diserahkan, serahkan terlebih dahulu sebelum mempublikasikannya.		API harus diserahkan terlebih dahulu sebelum dapat dipublikasikan. Untuk API yang belum diserahkan, serahkan terlebih dahulu sebelum mempublikasikannya.

   Catatan

   Setelah Anda mengubah kelompok sumber daya layanan untuk API yang telah dipublikasikan, Anda harus menguji, menyerahkan, dan mempublikasikan ulang API tersebut agar perubahan berlaku.

Cari API berdasarkan kode

Anda dapat mencari kode dalam API yang dibuat di editor kode pada ruang kerja saat ini.

1. Di panel navigasi kiri, klik ikon untuk membuka halaman pencarian kode.

   

2. Klik ikon di sebelah kanan kotak pencarian untuk memperluas kondisi filter.

   Anda dapat memasukkan kata kunci di kotak pencarian, seperti nama API, jalur API, deskripsi API, nama tabel, atau nama bidang. Anda juga dapat memfilter hasil pencarian berdasarkan kondisi seperti pemilik, alur bisnis, dan waktu modifikasi.

3. Lihat hasil pencarian.

   Hasil yang sesuai dengan kondisi pencarian akan ditampilkan di bawah kotak pencarian. Hasil tersebut mencakup informasi berikut:

   Catatan

   Hanya API yang telah dipublikasikan yang ditampilkan.

   • Nama API: Klik nama API untuk membuka halaman konfigurasinya di panel kanan.

   • Konten kode: Menampilkan kata kunci yang cocok, nomor barisnya, serta konteks singkat. Anda dapat menyalin konten kode yang cocok tersebut.

   • Informasi dasar: Menampilkan ID API, pemilik, alur bisnis, dan waktu modifikasi terakhir.