DataWorks:Manage API

Tampilkan API

1. Masuk ke Konsol DataWorks. Di Wilayah target, klik Data Analysis and Service > DataService Studio di panel navigasi sebelah kiri. Pilih ruang kerja dari daftar drop-down, lalu klik Go to DataService Studio.

2. Di halaman Service Development, buka Workflow > API.

3. Klik kanan API target, lalu pilih Details.

   Catatan

   Opsi Details hanya tersedia untuk API yang telah dipublikasikan. Jika API belum dipublikasikan, Anda dapat membuka halaman edit-nya, lalu klik Property di panel sebelah kanan untuk melihat informasi dasarnya.

Kloning API

Anda dapat mengkloning API ke path tertentu dalam struktur direktori:

1. Di halaman Service Development, buka Workflow > API.

2. Klik kanan API target, lalu pilih Cloning.

3. Di kotak dialog Clone API, konfigurasikan parameter berikut.

   Parameter	Deskripsi
   API Name	Nama harus terdiri dari 4 hingga 50 karakter dan dapat berisi karakter Tionghoa, huruf, angka, serta garis bawah (_). Nama harus dimulai dengan karakter Tionghoa atau huruf.
   APIPath	Path tempat API disimpan, misalnya /user. API Path dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-). Path harus dimulai dengan garis miring (/) dan tidak boleh melebihi 200 karakter.
   Description	Deskripsi API hasil kloning.
   Location	Direktori tempat menyimpan API.

4. Klik Confirm.

Hapus API

Di DataService Studio, Anda hanya dapat menghapus API yang belum dipublikasikan. Untuk menghapus API yang telah dipublikasikan, Anda harus membatalkan publikasinya terlebih dahulu:

1. (Opsional) Batalkan publikasi API.

   Jika API belum dipublikasikan, lewati langkah ini.

   1. Di halaman Service Development, klik Service Management di bagian atas untuk menuju halaman Manage APIs.

      Secara default, halaman ini menampilkan daftar Published APIs. Kolom Actions untuk setiap API menyediakan tombol seperti Unpublish, Authorization, Test, dan More.

   2. Di tab Published APIs, temukan API target, lalu klik Unpublish di kolom Actions.

   3. Setelah membatalkan publikasi API, klik Service Development di bagian atas halaman untuk kembali ke halaman Service Development.

2. Di halaman Service Development, buka Workflow > API.

3. Klik kanan API yang ingin Anda hapus, lalu pilih Delete.

   Penting

   Operasi ini tidak dapat dikembalikan. Lakukan dengan hati-hati.

Pindahkan API

Di DataService Studio, Anda hanya dapat memindahkan API yang belum dipublikasikan. Untuk memindahkan API yang telah dipublikasikan, Anda harus membatalkan publikasinya terlebih dahulu:

1. (Opsional) Batalkan publikasi API.

   Jika API belum dipublikasikan, lewati langkah ini.

   1. Di halaman Service Development, klik Service Management di bagian atas untuk menuju halaman Manage APIs.

      Secara default, halaman ini menampilkan daftar Published APIs. Kolom Actions untuk setiap API menyediakan tombol seperti Unpublish, Authorization, Test, dan More.

   2. Di tab Published APIs, temukan API target, lalu klik Unpublish di kolom Actions.

   3. Setelah membatalkan publikasi API, klik Service Development di bagian atas halaman untuk kembali ke halaman Service Development.

2. Di halaman Service Development, buka Workflow > API.

3. Klik kanan API yang ingin Anda pindahkan, lalu pilih Move.

4. Di kotak dialog Move Node, pilih Location, lalu klik Confirm.

5. Penting

   Memindahkan API dapat mengubah kelompoknya, yang berdampak pada URL endpoint setelah dipublikasikan. Lakukan dengan hati-hati saat memindahkan API yang telah dipublikasikan.

Operasi Batch

DataWorks memungkinkan Anda melakukan operasi batch pada API, seperti mengubah kelompok sumber daya DataService Studio, men-submit, dan mempublikasikannya. Hal ini memungkinkan Anda beralih antar kelompok sumber daya dan membawa API online secara efisien.

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

2. Di bagian atas halaman operasi batch, filter API berdasarkan kriteria seperti Workflow dan Owner.

3. Dalam daftar hasil filter, centang kotak API yang ingin Anda proses secara batch.

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

   Tabel berikut menjelaskan hubungan antara operasi batch dan status API.

   Operasi batch	Belum dipublikasikan dan belum disubmit	Belum dipublikasikan dan sudah disubmit	Sudah dipublikasikan dan belum disubmit	Sudah dipublikasikan dan sudah disubmit
   Modify Service Resource Group
   Submit		Anda tidak dapat men-submit API yang sudah disubmit. Untuk meng-submit ulang API tersebut, buka halaman edit-nya, lalu buka tab Version Management di panel sebelah kanan dan batalkan versi yang sebelumnya telah disubmit.		Anda tidak dapat men-submit API yang sudah disubmit. Untuk meng-submit ulang API tersebut, buka halaman edit-nya, lalu buka tab Version Management di panel sebelah kanan dan batalkan versi yang sebelumnya telah disubmit.
   Publish	API harus disubmit terlebih dahulu sebelum dapat dipublikasikan.		API harus disubmit terlebih dahulu sebelum dapat dipublikasikan.

   Catatan

   Setelah mengubah kelompok sumber daya untuk API yang telah dipublikasikan, Anda harus menguji, men-submit, dan mempublikasikan ulang API tersebut agar perubahan diterapkan.

Pencarian Kode API

Anda dapat mencari kode API yang dibuat dalam mode skrip di ruang kerja saat ini.

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

   Panel kiri halaman Service Development berisi beberapa ikon fungsi, termasuk Code, Table, dan Search. Panel utama pencarian kode berisi tab API dan Data Push. Bilah pencarian memungkinkan Anda mencari berdasarkan ID, nama, atau API Path. Di bawah bilah pencarian terdapat bagian business process yang dapat diciutkan.

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

   Anda dapat memasukkan kata kunci seperti nama API, API Path, deskripsi API, nama tabel, atau nama bidang di kotak pencarian untuk menemukan API. Anda juga dapat memfilter hasil pencarian berdasarkan kriteria seperti pemilik, proses bisnis, dan waktu modifikasi.

3. Lihat hasil pencarian.

   Hasil yang sesuai dengan kriteria pencarian Anda ditampilkan di bawah bilah pencarian dan mencakup informasi berikut:

   Catatan

   Hasil pencarian hanya mencakup API yang telah dipublikasikan.

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

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

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