全部产品
Search
文档中心

DataWorks:Uji API

更新时间:Jul 02, 2025

Setelah membuat API, Anda perlu mengujinya di DataService Studio sebelum mempublikasikannya ke API Gateway untuk memastikan bahwa parameter permintaan dan nilai balikan API sesuai dengan kebutuhan bisnis Anda. Anda juga dapat menguji API yang telah dipublikasikan. Topik ini menjelaskan cara menguji API yang sedang dikembangkan maupun yang telah dipublikasikan.

Latar Belakang

Saat menguji API, grup sumber daya bersama untuk DataService Studio digunakan untuk mengakses sumber data atau layanan backend guna memanggil API. Biaya akan dikenakan berdasarkan jumlah panggilan API dan waktu eksekusi panggilan tersebut. Untuk detail lebih lanjut tentang penagihan, lihat DataService Studio.

Uji API yang sedang dikembangkan

Anda dapat menguji API yang sedang dikembangkan di tab Pengembangan Layanan halaman DataService Studio. Sebelum melakukan pengujian, pastikan Anda telah membuat atau mendaftarkan API.

  1. Masuk ke Konsol DataWorks. Di 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 dari daftar drop-down dan klik Go to DataService Studio.

  2. Di halaman DataService Studio, klik Service Management di bilah navigasi atas. Di panel navigasi kiri tab Manajemen Layanan, klik Manage APIs. Pada tab Published APIs halaman Kelola API, temukan API yang ingin diuji dan klik Test di kolom Actions.

  3. Uji API.

    Di kotak dialog Test APIs, konfigurasikan semua parameter permintaan API.

  4. Klik Test untuk memicu pengujian API.

    • Informasi terkait ditampilkan di bagian Request Details dan Response Details di sebelah kanan halaman Uji API.

    • Nilai API call latency value menunjukkan latensi permintaan API saat ini. Nilai ini digunakan untuk mengevaluasi kinerja API. Jika latensi tinggi, disarankan untuk mengoptimalkan logika kueri atau sumber data.

    • Jika pengujian API gagal, periksa pesan kesalahan, ubah pengaturan API, lalu uji ulang API.

Uji API yang telah dipublikasikan

Anda dapat menguji API yang telah dipublikasikan di tab Service Management halaman DataService Studio. Sebelum melakukan pengujian, pastikan API telah dikirimkan dan dipublikasikan. Untuk informasi lebih lanjut, lihat Publikasikan API.

  1. Di halaman DataService Studio, klik Service Management di pojok kanan atas.

  2. Di panel navigasi kiri, klik Test APIs.

  3. Pilih API yang ingin diuji dari daftar drop-down, dan pastikan semua request parameters API telah dikonfigurasi.

    Request Parameters

  4. Klik Test untuk memicu pengujian API. Informasi terkait ditampilkan di bagian Request Details dan Response Details di sebelah kanan halaman Uji API.

    Catatan
    • Di halaman Test APIs, Anda hanya dapat menguji API yang telah dipublikasikan dan tidak dapat memperbarui contoh respons sukses untuk API tersebut.

    • Jika fitur paging returned results diaktifkan untuk API, hasil yang dikembalikan akan diurutkan berdasarkan sumber data. Anda dapat mengonfigurasi field for sorting dalam mode codeless UI untuk mengurutkan hasil yang dikembalikan. Atau, tambahkan ORDER BY ke pernyataan SQL dalam mode code editor untuk mengurutkan hasil yang dikembalikan.

Apa yang Harus Dilakukan Selanjutnya

Setelah menguji API yang sedang dikembangkan, Anda dapat mempublikasikannya agar pengguna lain dapat memanggil API tersebut. Untuk informasi lebih lanjut tentang cara mempublikasikan API, lihat Publikasikan API.