DataWorks：Membuat API menggunakan editor kode

Pergi ke halaman DataService Studio

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

Hasilkan API

1. Di panel Service Development, gerakkan pointer di atas ikon dan pilih Create API > Generate API.

   Anda juga dapat memilih proses bisnis, klik kanan API, lalu pilih Create API > Generate API.

2. Di kotak dialog Generate API, konfigurasikan parameter.

   Parameter	Deskripsi
   API Mode	Mode yang digunakan untuk membuat API. Nilai valid: Wizard Mode dan Script Mode. Dalam contoh ini, pilih Script Mode.
   SQL Mode	Mode SQL. Nilai valid: Basic SQL: Gunakan pernyataan SQL dasar untuk mengimplementasikan logika kueri. Mode ini menyediakan kemampuan SQL yang sama seperti pada versi sebelumnya. Advanced SQL: Gunakan pernyataan SQL dengan tag MyBatis untuk mengimplementasikan logika kueri. Mode ini mendukung jenis tag berikut: if, choose, when, otherwise, trim, foreach, dan where.
   API Name	Nama API. Nama harus terdiri dari 4 hingga 50 karakter, dan dapat berisi huruf, angka, serta garis bawah (_). Nama harus dimulai dengan huruf.
   API Path	Path API, seperti /user.
   Protocol	Protokol yang digunakan oleh API. Nilai valid: HTTP dan HTTPS. Jika Anda ingin memanggil API menggunakan HTTPS, Anda harus mengikat nama domain independen ke grup API tempat API tersebut termasuk di konsol API Gateway setelah API diterbitkan ke API Gateway. Anda juga harus mengunggah sertifikat SSL di konsol API Gateway. Untuk informasi lebih lanjut, lihat Aktifkan HTTPS untuk operasi API.
   Request Method	Metode permintaan. Nilai valid: GET dan POST. Catatan Jika Anda memilih GET untuk parameter Request Method, Anda hanya dapat memilih QUERY untuk parameter Position. Jika Anda memilih POST untuk parameter Metode Permintaan, Anda dapat memilih QUERY atau BODY untuk parameter Position.
   Response Type	Format data yang dikembalikan oleh API. Atur nilainya menjadi JSON.
   Visible Scope	Rentang pengguna yang dapat melihat API. Nilai valid: Workspace: API terlihat oleh semua anggota di workspace saat ini. Private: API hanya terlihat oleh pemiliknya, dan izin pada API tidak dapat diberikan kepada anggota lain. Catatan Jika Anda mengatur parameter ini ke Private, anggota lain di ruang kerja tidak dapat melihat API dalam daftar API.
   Label	Pilih tag dari daftar drop-down Label. Untuk informasi lebih lanjut, lihat Create and manage API tag. Catatan Tag dapat memiliki panjang hingga 20 karakter, dan dapat berisi huruf, angka, serta garis bawah (_). Anda dapat menambahkan paling banyak lima tag ke sebuah API.
   Description	Deskripsi API. Deskripsi dapat memiliki panjang hingga 2.000 karakter.
   Destination Folder	Folder tempat Anda ingin menyimpan API.

3. Klik OK.

Konfigurasikan API

1. Pilih tabel

Klik dua kali API di daftar API. Pada tab yang muncul, konfigurasikan parameter Datasource Type, Datasource Name, dan Data Source Environment.

2. Tulis pernyataan SQL untuk kueri data

Di bagian Edit Query SQL, tulis pernyataan SQL untuk kueri data.

3. Konfigurasikan parameter permintaan

Di panel navigasi sebelah kanan, klik tab Request Param. Pada tab Param Permintaan, konfigurasikan parameter berdasarkan kebutuhan bisnis Anda.

4. Konfigurasikan parameter respons

Di panel navigasi sebelah kanan, klik tab Response Param. Pada tab Param Respons, konfigurasikan parameter.

1. Konfigurasikan parameter respons.

   Jika Anda mengatur parameter Mode SQL ke Advanced SQL, Anda harus secara manual menambahkan semua parameter respons yang ditentukan dalam pernyataan SQL ke daftar parameter. Ini memastikan bahwa parameter yang dijelaskan dalam detail API konsisten dengan parameter yang digunakan.

   Parameter	Deskripsi
   Parameter Name	Nama parameter respons. Nama dapat memiliki panjang hingga 64 karakter dan dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-). Nama harus dimulai dengan huruf.
   Type	Tipe data parameter permintaan. Nilai valid: STRING, INT, LONG, FLOAT, DOUBLE, dan BOOLEAN.
   Example Value	Nilai contoh parameter respons.
   Description	Deskripsi parameter respons.

2. Konfigurasikan parameter Pagination for Return Results.

   • Jika Anda tidak mengaktifkan Pagination for Return Results, API akan mengembalikan maksimal 2.000 rekaman secara default.

   • Jika lebih dari 2.000 rekaman mungkin dikembalikan, kami sarankan Anda mengaktifkan Pagination for Return Results. Jika Anda mengaktifkan Paginasi untuk Hasil Kembali, Anda dapat pergi ke tab Resource Group untuk mengonfigurasi parameter Jumlah Maksimum Rekaman Data untuk Permintaan Tunggal berdasarkan grup sumber daya yang Anda pilih.

   Catatan

   Setelah Anda mengaktifkan Pagination for Return Results, jumlah rekaman yang dikembalikan bergantung pada pengaturan paginasi. Jika Anda menulis pernyataan SQL untuk menetapkan batas jumlah rekaman yang dikembalikan di bagian Edit Query SQL, batas tersebut tidak berlaku.

   Parameter umum berikut ditampilkan saat Anda mengaktifkan Paginasi untuk Hasil Kembali:

   • Parameter permintaan umum

     • returnTotalNum: menentukan apakah akan mengembalikan jumlah total entri untuk permintaan tunggal.

     • pageNum: nomor halaman yang akan dikembalikan.

     • pageSize: jumlah entri yang dikembalikan di setiap halaman.

   • Parameter respons umum

     • pageNum: nomor halaman yang akan dikembalikan.

     • pageSize: jumlah entri yang dikembalikan di setiap halaman.

     • totalNum: jumlah total entri yang dikembalikan.

   Catatan

   Parameter permintaan bersifat opsional untuk API. Jika Anda tidak menentukan parameter permintaan untuk API, Anda harus mengaktifkan Pagination for Return Results.

5. Konfigurasikan filter

Jika Anda perlu melakukan pra-pemrosesan parameter permintaan API atau memproses hasil yang dikembalikan oleh API, Anda dapat mengonfigurasi filter untuk API dengan melakukan langkah-langkah berikut: Di panel navigasi sebelah kanan, klik Filter. Di panel Filter, pilih Use Pre-filter atau Use Post-filter berdasarkan kebutuhan bisnis Anda. Setelah Anda mengonfigurasi parameter Function Type, pilih satu atau lebih fungsi dari daftar drop-down di sebelah kotak centang Gunakan Pra-filter atau Gunakan Pasca-filter. Jika Anda memilih beberapa fungsi, fungsi-fungsi tersebut digunakan untuk memproses parameter berdasarkan urutan pemilihan. Kemudian, Anda dapat mengklik Preview Responses Returned by API Operation dan memeriksa apakah hasil pemrosesan fungsi yang dipilih sesuai dengan harapan Anda. Untuk informasi lebih lanjut tentang cara membuat dan menggunakan filter, lihat Buat fungsi Aviator dan Buat fungsi Python.

Catatan

• Jika Anda ingin menggunakan fungsi Python sebagai filter, Anda harus mengaktifkan Edisi Profesional DataWorks atau edisi yang lebih canggih dan menggunakan grup sumber daya dibagi untuk DataService Studio.

• Jika Anda ingin menggunakan fungsi Aviator sebagai filter, semua edisi DataWorks didukung, tetapi Anda harus menggunakan grup sumber daya eksklusif untuk DataService Studio.

• Jika fungsi yang ingin Anda gunakan tidak tersedia di daftar drop-down, periksa apakah fungsi tersebut telah diterbitkan. Jika fungsi tersebut belum diterbitkan, terbitkan fungsi tersebut. Sebagai alternatif, Anda dapat membuat dan menerbitkan fungsi baru. Untuk informasi lebih lanjut, lihat Terbitkan fungsi.

6. Konfigurasikan grup sumber daya untuk DataService Studio

1. Di panel navigasi sebelah kanan, klik tab Resource Group. Di bagian Resource Group Type, konfigurasikan parameter Skema.

   Anda dapat memilih Exclusive Resource Group for DataService Studio atau Shared Resource Group for DataService Studio untuk parameter Skema. Jika Anda memilih Exclusive Resource Group for DataService Studio, pilih grup sumber daya eksklusif dari daftar drop-down Grup Sumber Daya Eksklusif untuk DataService Studio. Jika Anda memilih Shared Resource Group for DataService Studio, Anda tidak perlu memilih grup sumber daya. DataWorks secara otomatis menggunakan grup sumber daya dibagi untuk menghasilkan API.

   Catatan

   1. Jika grup sumber daya yang ingin Anda gunakan tidak ditampilkan di daftar drop-down, pergi ke halaman Grup Sumber Daya, temukan grup sumber daya, dan klik Associate Workspace di kolom Actions untuk mengasosiasikan grup sumber daya dengan workspace.

   2. Jika grup sumber daya yang ingin Anda gunakan ditampilkan di daftar drop-down tetapi tidak dapat dipilih, pergi ke halaman Grup Sumber Daya, temukan grup sumber daya, dan pilih > > > Manage Quota di kolom Actions untuk pergi ke kotak dialog Kelola Kuota. Di kotak dialog Kelola Kuota, konfigurasikan secara manual parameter Occupied CUs atau Minimum CUs untuk grup sumber daya untuk DataService Studio. Jika metode penagihan grup sumber daya adalah bayar sesuai pemakaian, Anda harus mengonfigurasi parameter CU Terpakai. Jika metode penagihan grup sumber daya adalah berlangganan, Anda harus mengonfigurasi parameter CU Minimum.

2. Di bagian Environment Configuration, Anda dapat mengonfigurasi parameter Memory, Function Timeout, dan Maximum Number of Data Records for a Single Request.

   1. Nilai maksimum parameter Waktu Habis Fungsi bervariasi berdasarkan jenis grup sumber daya yang Anda pilih dan jenis instance API Gateway yang Anda gunakan:

      1. Instance API Gateway Bersama: Nilai maksimum parameter ini adalah 30000.

      2. Instance API Gateway Khusus: Jika Anda memilih Grup Sumber Daya Dibagi untuk DataService Studio, nilai maksimum parameter ini adalah 30000. Jika Anda memilih Grup Sumber Daya Eksklusif untuk DataService Studio, nilai maksimum parameter ini adalah 90000.

      Catatan

      Waktu respons operasi API bergantung pada waktu eksekusi aktual pernyataan SQL. Untuk mencegah kegagalan permintaan yang disebabkan oleh waktu habis respons, konfigurasikan timeout period berdasarkan waktu eksekusi aktual pernyataan SQL.

   2. Nilai maksimum parameter Jumlah Maksimum Rekaman Data untuk Permintaan Tunggal bervariasi berdasarkan jenis grup sumber daya yang Anda pilih:

      1. Jika Anda memilih Grup Sumber Daya Dibagi untuk DataService Studio, nilai maksimum parameter ini adalah 2000.

      2. Jika Anda memilih Grup Sumber Daya Eksklusif untuk DataService Studio, nilai maksimum parameter ini adalah 10000.

      Catatan

      Tidak ada batasan yang diberlakukan pada jumlah total hasil yang dikembalikan. Jumlah hasil yang dikembalikan sama dengan jumlah hasil kueri aktual.

7. Simpan dan komit API

Klik ikon di bilah alat atas. Setelah API disimpan, grup sumber daya yang dipilih akan berlaku selama pengujian.

Setelah API dikonfigurasi, Anda dapat menguji API. Untuk informasi lebih lanjut, lihat Uji API.

Setelah pengujian berhasil, klik Submit di pojok kanan atas.

Di panel navigasi sebelah kanan tab konfigurasi API, klik Version. Temukan versi API yang ingin Anda terbitkan dan klik Application for publication di kolom Aksi untuk pergi ke halaman aplikasi. Gunakan tipe aplikasi default Publish data service API dan masukkan alasan aplikasi di bidang Reason for application. Lalu, klik Apply for permission untuk mengirimkan aplikasi.

Catatan

Jika Anda mendefinisikan kebijakan persetujuan di Pusat Persetujuan DataWorks, API harus disetujui sebelum API dapat diterbitkan. Untuk informasi lebih lanjut, lihat Ikhtisar.

Setelah API diterbitkan, konfigurasi grup sumber daya untuk DataService Studio berlaku saat API dipanggil.

Di tab Service Development, Anda dapat menemukan API terdaftar di panel navigasi sebelah kiri dan mengelola API. Misalnya, Anda dapat mengkloning atau menghapus API. Di tab Service Management, Anda dapat menemukan API yang diterbitkan dan melihat detail API yang diterbitkan. Untuk informasi lebih lanjut, lihat Lihat, hapus, pindahkan, dan kloning API, lakukan operasi batch pada beberapa API, dan gunakan fitur pencarian kode untuk mencari API.

Di panel navigasi sebelah kanan, klik tab Response Param. Di tab Response Param, konfigurasikan parameter yang diperlukan.

1. Konfigurasikan parameter respons.

   Jika Anda mengatur parameter SQL Mode ke Advanced SQL, Anda harus menambahkan secara manual semua parameter respons yang ditentukan dalam pernyataan SQL ke daftar parameter. Hal ini memastikan konsistensi antara detail API dan parameter yang digunakan.

   Parameter	Deskripsi
   Parameter Name	Nama parameter respons. Nama dapat memiliki panjang hingga 64 karakter dan dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-). Nama harus dimulai dengan huruf.
   Type	Tipe data dari parameter permintaan. Nilai yang valid: STRING, INT, LONG, FLOAT, DOUBLE, dan BOOLEAN.
   Example Value	Nilai contoh dari parameter respons.
   Description	Deskripsi dari parameter respons.

2. Konfigurasikan parameter Pagination for Return Results.

   • Jika Anda tidak mengaktifkan Pagination for Return Results, API akan mengembalikan hingga 2.000 rekaman secara default.

   • Jika lebih dari 2.000 rekaman mungkin dikembalikan, kami sarankan Anda mengaktifkan Pagination for Return Results. Setelah diaktifkan, Anda dapat pergi ke tab Resource Group untuk mengonfigurasi parameter Jumlah Maksimum Rekaman Data untuk Satu Permintaan berdasarkan grup sumber daya yang dipilih.

   Catatan

   Setelah mengaktifkan Pagination for Return Results, jumlah rekaman yang dikembalikan bergantung pada pengaturan halaman. Jika Anda menulis pernyataan SQL untuk menetapkan batas jumlah rekaman yang dikembalikan di bagian Edit Query SQL, batas tersebut tidak akan berlaku.

   Parameter umum berikut ditampilkan ketika Anda mengaktifkan Pagination for Return Results:

   • Parameter permintaan umum

     • returnTotalNum: menentukan apakah akan mengembalikan jumlah total entri untuk satu permintaan.

     • pageNum: nomor halaman yang akan dikembalikan.

     • pageSize: jumlah entri yang akan dikembalikan di setiap halaman.

   • Parameter respons umum

     • pageNum: nomor halaman yang akan dikembalikan.

     • pageSize: jumlah entri yang akan dikembalikan di setiap halaman.

     • totalNum: jumlah total entri yang dikembalikan.

   Catatan

   Parameter permintaan bersifat opsional untuk sebuah API. Jika Anda tidak menentukan parameter permintaan untuk sebuah API, Anda harus mengaktifkan Pagination for Return Results.

5. Konfigurasi filter

6. Konfigurasikan grup sumber daya untuk DataService Studio

1. Di panel navigasi sebelah kanan, klik tab Resource Group. Pada bagian Resource Group Type, konfigurasikan parameter Schema.

   Anda dapat memilih Exclusive Resource Group for DataService Studio atau Shared Resource Group for DataService Studio untuk parameter Scheme. Jika memilih Exclusive Resource Group for DataService Studio, pilih grup sumber daya eksklusif dari daftar drop-down Exclusive Resource Group for DataService Studio. Jika memilih Shared Resource Group for DataService Studio, Anda tidak perlu memilih grup sumber daya. DataWorks secara otomatis menggunakan grup sumber daya bersama untuk menghasilkan API.

   Catatan

   1. Jika grup sumber daya yang ingin digunakan tidak muncul dalam daftar drop-down, buka halaman Resource Groups, temukan grup sumber daya tersebut, dan klik Associate Workspace di kolom Actions untuk mengaitkan grup sumber daya dengan workspace.

   2. Jika grup sumber daya yang ingin digunakan muncul dalam daftar drop-down tetapi tidak dapat dipilih, buka halaman Resource Groups, temukan grup sumber daya tersebut, dan pilih > > > Manage Quota di kolom Actions untuk membuka kotak dialog Manage Quota. Di kotak dialog Manage Quota, konfigurasikan parameter Occupied CUs atau Minimum CUs untuk grup sumber daya DataService Studio. Jika metode penagihan grup sumber daya adalah bayar sesuai pemakaian, Anda harus mengonfigurasi parameter Occupied CUs. Jika metode penagihan grup sumber daya adalah langganan, Anda harus mengonfigurasi parameter Minimum CUs.

2. Pada bagian Environment Configuration, Anda dapat mengonfigurasi parameter Memory, Function Timeout, dan Maximum Number of Data Records for a Single Request.

   1. Nilai maksimum parameter Function Timeout bervariasi berdasarkan jenis grup sumber daya yang dipilih dan jenis instance API Gateway yang digunakan:

      1. Instance Shared API Gateway: Nilai maksimum parameter ini adalah 30.000.

      2. Instance Dedicated API Gateway: Jika memilih Shared Resource Group for DataService Studio, nilai maksimum parameter ini adalah 30.000. Jika memilih Exclusive Resource Group for DataService Studio, nilai maksimum parameter ini adalah 90.000.

      Catatan

      Waktu respons operasi API bergantung pada waktu eksekusi aktual dari pernyataan SQL. Untuk mencegah kegagalan permintaan akibat batas waktu respons, konfigurasikan timeout period berdasarkan waktu eksekusi aktual dari pernyataan SQL.

   2. Nilai maksimum parameter Maximum Number of Data Records for a Single Request bervariasi berdasarkan jenis grup sumber daya yang dipilih:

      1. Jika memilih Shared Resource Group for DataService Studio, nilai maksimum parameter ini adalah 2.000.

      2. Jika memilih Exclusive Resource Group for DataService Studio, nilai maksimum parameter ini adalah 10.000.

      Catatan

      Tidak ada batasan yang diberlakukan pada jumlah total hasil yang dikembalikan. Jumlah hasil yang dikembalikan sama dengan jumlah hasil kueri aktual.

7. Simpan dan komit API

Klik ikon di bilah alat atas. Setelah API disimpan, grup sumber daya yang dipilih akan diterapkan selama pengujian.