DataService Studio memungkinkan Anda membuat API menggunakan antarmuka tanpa kode atau editor kode. Saat menggunakan antarmuka tanpa kode untuk membuat API, Anda dapat mengonfigurasi API secara visual tanpa perlu menulis kode. Topik ini menjelaskan cara menggunakan antarmuka tanpa kode untuk membuat API.
Prasyarat
Sumber data dikonfigurasi di halaman Data Sources. Untuk informasi lebih lanjut, lihat Tambahkan sumber data.
Grup sumber daya dibuat untuk DataService Studio. Kami merekomendasikan Anda menggunakan grup sumber daya serverless di lingkungan produksi. Untuk informasi lebih lanjut, lihat Persiapan.
Informasi latar belakang
Jika Anda memiliki persyaratan kueri yang dipersonalisasi, Anda dapat menggunakan editor kode yang disediakan oleh DataWorks untuk membuat API. Saat menggunakan editor kode untuk membuat API, Anda dapat menyesuaikan Pernyataan SQL untuk API tersebut. Editor kode memungkinkan Anda menggunakan fitur seperti kueri gabungan tabel, kueri kompleks, dan fungsi agregat. Misalnya, jika Anda ingin menentukan parameter permintaan untuk mengkueri data dalam rentang nilai tertentu dari suatu bidang, Anda dapat membuat API di editor kode.
Pergi ke halaman DataService Studio
Masuk ke Konsol DataWorks. Di bilah navigasi atas, pilih wilayah yang diinginkan. Di panel navigasi sisi kiri, pilih . Di halaman yang muncul, pilih ruang kerja yang diinginkan dari daftar drop-down dan klik Go to DataService Studio.
Buat API
Di panel Service Development, gerakkan pointer di atas ikon
dan pilih .Anda juga bisa mengklik proses bisnis, klik kanan API, dan kemudian pilih .
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 Wizard Mode.
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 adalah path permintaan API relatif terhadap alamat host layanan. Contoh: /user.
CatatanPath dapat memiliki panjang hingga 200 karakter dan dapat berisi huruf, angka, garis bawah (_), serta tanda hubung (-). Path harus dimulai dengan garis miring (/).
Protocol
Protokol yang digunakan oleh API. Nilai valid: HTTP dan HTTPS.
Jika Anda perlu memanggil API menggunakan HTTPS, Anda harus mengaitkan nama domain independen dengan API di konsol API Gateway setelah API diterbitkan ke API Gateway. Anda juga harus mengunggah Sertifikat Secure Sockets Layer (SSL) di konsol API Gateway. Untuk informasi lebih lanjut, lihat Aktifkan HTTPS untuk operasi API.
Request Method
Metode permintaan. Nilai valid: GET dan POST
CatatanJika Anda memilih GET untuk parameter Request Method, Anda hanya dapat memilih QUERY untuk parameter Parameter Position. Jika Anda memilih POST untuk parameter Metode Permintaan, Anda dapat memilih QUERY atau BODY untuk parameter 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 ruang kerja saat ini.
Private: API hanya terlihat oleh pemiliknya dan izin pada API tidak dapat diberikan kepada anggota lain.
CatatanJika Anda mengatur parameter ini ke Privat, anggota lain di ruang kerja tidak dapat melihat API di daftar API.
Label
Pilih label dari daftar drop-down Label. Untuk informasi lebih lanjut, lihat Buat dan kelola tag API.
CatatanSebuah tag dapat memiliki panjang hingga 20 karakter dan dapat berisi huruf, angka, serta garis bawah (_). Anda dapat mengatur maksimal lima tag untuk sebuah API.
Description
Deskripsi API. Deskripsi dapat memiliki panjang hingga 2.000 karakter.
Destination Folder
Folder tempat Anda ingin menyimpan API. Anda dapat memilih proses bisnis dari daftar drop-down. Setelah Anda memilih proses bisnis, folder akan dibuat di bawah proses bisnis dan API disimpan di folder tersebut. Secara default, folder berada dalam format Proses Bisnis/Nama Proses Bisnis/API, seperti Proses Bisnis/ceshi/API.
Klik OK.
Konfigurasikan API
1. Pilih tabel
Klik dua kali API di daftar API. Di tab yang muncul, konfigurasikan parameter Datasource Type, Datasource Name, Datasource Environment, dan Table Name di bagian Select Table.
Parameter yang perlu Anda konfigurasikan bervariasi berdasarkan jenis sumber data yang dipilih. Parameter di konsol yang berlaku.
Sebelum Anda memilih tabel untuk API, Anda harus mengonfigurasi sumber data di Data Integration. Anda dapat memasukkan nama tabel di bidang Nama Tabel untuk mencari tabel yang ingin Anda gunakan.
Untuk ruang kerja dalam mode standar, Anda dapat memilih Produksi atau Lingkungan untuk parameter Datasource Environment. Untuk informasi lebih lanjut, lihat Perbedaan antara ruang kerja dalam mode dasar dan ruang kerja dalam mode standar.
Jika Anda memilih tabel MaxCompute untuk API, Anda dapat memilih Acceleration Service atau MCQA untuk parameter Metode Akselerasi untuk akselerasi. Layanan Akselerasi adalah metode akselerasi yang disediakan oleh DataWorks dan MCQA adalah metode akselerasi yang disediakan oleh MaxCompute. Jika Anda memilih Acceleration Service, Anda harus memastikan bahwa item akselerasi telah dibuat. Untuk informasi lebih lanjut, lihat Solusi akselerasi untuk kueri data berbasis API.
Setelah Anda membuat API, tab konfigurasi API muncul. Kemudian, Anda dapat memilih tabel untuk API.
2. Konfigurasikan parameter di bagian Pilih Parameter
Di bagian Select Parameters, konfigurasikan parameter permintaan dan respons untuk API.
Setelah Anda memilih tabel di bagian Pilih Tabel, semua bidang di tabel muncul di bagian Select Parameters. Di kolom Set as Req Param, pilih kotak centang bidang yang ingin Anda tentukan sebagai parameter permintaan. Di kolom Set as Resp Param, pilih kotak centang bidang yang ingin Anda tentukan sebagai parameter respons.
Untuk mengurutkan data yang dikembalikan oleh API berdasarkan suatu field tertentu, temukan field tersebut dan klik Add di kolom Add to field sort. Setelah Anda mengklik Add, field tersebut akan ditambahkan ke bagian Sort field.
Fitur pengurutan memungkinkan Anda menentukan bidang berdasarkan mana data yang dikembalikan oleh API diurutkan. Bidang dengan nomor urutan lebih kecil di bagian Bidang Urut memiliki prioritas lebih tinggi dalam pengurutan data. Anda dapat mengklik Move up atau Move down untuk menyesuaikan urutan bidang. Anda dapat memilih Ascending order atau Descending order di kolom Pengurutan setiap bidang untuk menentukan mode pengurutan.
3. Konfigurasikan parameter permintaan
Di panel navigasi sisi kanan, klik tab Request Param. Di tab Param Permintaan, konfigurasikan parameter berdasarkan kebutuhan bisnis Anda.
Sebelum Anda melihat pratinjau hasil, Anda harus mengonfigurasi informasi seperti nilai contoh, nilai default, dan deskripsi untuk setiap parameter permintaan API.
Untuk meningkatkan efisiensi pencocokan, tentukan bidang terindeks sebagai parameter permintaan.
Jika Anda membuat API menggunakan antarmuka tanpa kode, Anda tidak dapat mengonfigurasi dua parameter untuk bidang untuk menghasilkan rentang nilai. Jika Anda ingin mengonfigurasi beberapa parameter untuk bidang, Anda dapat membuat API menggunakan editor kode. Untuk informasi lebih lanjut, lihat Buat API menggunakan editor kode.
Parameter | Deskripsi |
Parameter Name | Nama parameter permintaan. Nama dapat memiliki panjang hingga 64 karakter dan dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-). Nama harus dimulai dengan huruf. |
Bound Field | Nilai tidak dapat diubah. Jika Anda ingin mengubah nilai, gunakan editor kode untuk membuat API. Untuk informasi lebih lanjut, lihat Buat API menggunakan editor kode. |
Type | Tipe parameter permintaan. Nilai valid: STRING, INT, LONG, FLOAT, DOUBLE, dan BOOLEAN. |
Position | Posisi parameter permintaan. Nilai valid: QUERY dan BODY. Catatan Jika Anda mengatur parameter Position ke BODY untuk satu atau lebih parameter permintaan, Anda harus mengonfigurasi parameter Content-Type untuk mendefinisikan format parameter permintaan di badan permintaan. Nilai valid untuk parameter Content-Type:
|
Operator | Operator yang digunakan untuk menghubungkan atau membandingkan nilai parameter permintaan dengan nilai yang Anda tentukan. Anda dapat memilih salah satu operator berikut:
Catatan Jika Anda mengatur parameter Datasource Type ke Tablestore di bagian Select Table, parameter Operator hanya dapat diatur menjadi Equal. |
Required | Menentukan apakah parameter permintaan diperlukan. |
Example Value | Nilai contoh parameter permintaan. |
Default Value | Nilai default parameter permintaan. |
Description | Deskripsi parameter permintaan. |
4. Konfigurasikan parameter respons
Di panel navigasi sisi kanan, klik tab Response Param. Di tab Param Respons, konfigurasikan parameter.
Konfigurasikan parameter respons.
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.
Bound Field
Nilai tidak dapat diubah.
Type
Tipe parameter permintaan. Nilai valid: STRING, INT, LONG, FLOAT, DOUBLE, dan BOOLEAN.
Example Value
Nilai contoh parameter respons.
Description
Deskripsi parameter respons.
Konfigurasikan parameter Pagination for Return Results.
Jika Anda tidak memilih Pagination, API mengembalikan maksimal 2.000 rekaman secara default.
Jika lebih dari 2.000 rekaman mungkin dikembalikan, kami sarankan Anda memilih Pagination. Jika Anda memilih Paginasi, Anda dapat pergi ke tab Resource Group untuk mengonfigurasi parameter Jumlah Maksimum Rekaman Data untuk Permintaan Tunggal berdasarkan grup sumber daya yang Anda pilih.
Parameter umum berikut tersedia jika Anda mengaktifkan Paginasi untuk Hasil Kembali.
Parameter permintaan umum
pageNum: nomor halaman.
pageSize: jumlah entri yang dikembalikan per halaman.
Parameter respons umum
pageNum: nomor halaman.
pageSize: jumlah entri yang dikembalikan per halaman.
totalNum: jumlah total entri yang dikembalikan.
CatatanParameter permintaan bersifat opsional untuk API. Jika Anda tidak menentukan parameter permintaan untuk API, Anda harus memilih Pagination.
5. Konfigurasikan filter
Jika Anda perlu memproses parameter permintaan API sebelumnya atau memproses hasil yang dikembalikan oleh API, Anda dapat melakukan langkah-langkah berikut untuk mengonfigurasi filter untuk API: Di panel navigasi sisi kanan, klik tab Filter. Di tab 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 mereka. Kemudian, Anda dapat mengklik Preview Responses Returned by API Operation dan periksa 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.
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 khusus 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. Anda juga dapat membuat dan menerbitkan fungsi. Untuk informasi lebih lanjut, lihat Terbitkan fungsi.
6. Konfigurasikan grup sumber daya untuk DataService Studio
Di panel navigasi sisi 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.
CatatanJika Anda memilih Shared Resource Group for DataService Studio untuk parameter Skema, grup sumber daya hanya dapat digunakan di lingkungan pengujian. Kami sarankan Anda tidak menggunakan grup sumber daya di lingkungan produksi.
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 ruang kerja.
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 langganan, Anda harus mengonfigurasi parameter CU Minimum.
Di bagian Environment Configuration, Anda dapat mengonfigurasi parameter Memory, Function Timeout, serta Maximum Number of Data Records for a Single Request.
Nilai maksimum parameter Batas Waktu Fungsi bervariasi berdasarkan jenis grup sumber daya yang Anda pilih dan jenis instance API Gateway yang Anda gunakan:
Instance API Gateway Bersama: Nilai maksimum parameter ini adalah 30.000.
Instance API Gateway Khusus: Jika Anda memilih Grup Sumber Daya Dibagi untuk DataService Studio, nilai maksimum parameter ini adalah 30.000. Jika Anda memilih Grup Sumber Daya Eksklusif untuk DataService Studio, nilai maksimum parameter ini adalah 90.000.
CatatanWaktu respons operasi API bergantung pada waktu eksekusi aktual dari Pernyataan SQL. Untuk mencegah kegagalan permintaan yang disebabkan oleh batas waktu respons, konfigurasikan timeout period berdasarkan waktu eksekusi aktual dari Pernyataan SQL.
Nilai maksimum parameter Jumlah Maksimum Rekaman Data untuk Permintaan Tunggal bervariasi berdasarkan jenis grup sumber daya yang Anda pilih:
Jika Anda memilih Grup Sumber Daya Dibagi untuk DataService Studio, nilai maksimum parameter ini adalah 2.000.
Jika Anda memilih Grup Sumber Daya Eksklusif untuk DataService Studio, nilai maksimum parameter ini adalah 10.000.
CatatanTidak ada batasan yang diberlakukan pada jumlah total hasil yang dikembalikan. Jumlah hasil yang dikembalikan sama dengan jumlah aktual hasil kueri.
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 sisi kanan tab konfigurasi API, klik Version. Temukan versi API yang ingin Anda terbitkan dan klik Application for publication di kolom Tindakan untuk pergi ke halaman aplikasi. Gunakan tipe aplikasi default Publish data service API dan masukkan alasan aplikasi di bidang Reason for application. Kemudian, klik Apply for permission untuk mengirimkan aplikasi.
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 sisi 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.
Beralih dari antarmuka tanpa kode ke editor kode
Di tab konfigurasi API, Anda dapat beralih dari antarmuka tanpa kode ke editor kode.
Di panel Service Development, klik tempat API yang diinginkan berada.
Temukan API dan klik dua kali API tersebut. Tab konfigurasi API muncul.
Klik ikon
di bilah alat atas.Di pesan Note, klik OK. Kemudian, Anda dapat melihat Pernyataan SQL API di bagian Edit Query SQL.
PentingDataService Studio hanya memungkinkan Anda beralih dari antarmuka tanpa kode ke editor kode.
Setelah Anda beralih dari antarmuka tanpa kode ke editor kode, Anda tidak dapat beralih kembali ke antarmuka tanpa kode.