Looker API Explorer adalah ekstensi — aplikasi web yang dibuat menggunakan komponen Looker — yang dikembangkan menggunakan framework ekstensi Looker dan di-deploy melalui Looker Marketplace.
API Explorer menyediakan aset berikut:
- Dokumentasi untuk semua metode dan jenis Looker API
- Deklarasi metode dan jenis dalam semua bahasa SDK yang didukung
- Link ke contoh fungsi SDK yang menggunakan metode API
- Link ke halaman API Explorer untuk metode dan jenis yang direferensikan
- Fungsi Run It yang memungkinkan Anda menjalankan panggilan API secara langsung dan menyediakan kode untuk panggilan API, respons API, dan fungsi SDK
- Alat perbandingan yang menunjukkan perbedaan pada versi Looker API
Pengguna tidak perlu login untuk versi ekstensi API Explorer, karena API Explorer menggunakan akun pengguna aktif untuk permintaan API. Ini memastikan bahwa pengguna hanya bisa melakukan panggilan API yang menjadi haknya sekaligus menghilangkan keharusan mereka untuk memberikan kredensial API.
Fitur sudo as other user Looker juga dapat digunakan untuk membuat permintaan API sebagai pengguna yang berbeda guna membantu mendiagnosis masalah akses.
Menginstal API Explorer
Penjelajah API tersedia di Marketplace Looker.
Sebelum menginstal API Explorer dari Marketplace, admin Looker harus mengaktifkan fitur Framework Ekstensi.
Untuk menginstal aplikasi, seperti ekstensi API Explorer, dari Marketplace Anda harus memiliki izin develop, manage_models, dan deploy. Setelah API Explorer diinstal, semua pengguna yang memiliki setidaknya izin access_data pada model extension_api_explorer dapat menggunakan API Explorer. Setiap pengguna dapat melihat semua endpoint API di API Explorer, tetapi hanya dapat menjalankan endpoint yang diizinkan oleh izinnya.
Jika admin Looker Anda telah mengaktifkan opsi Instal Otomatis di halaman Marketplace di bagian Platform pada menu Admin Looker, API Explorer akan otomatis diinstal pada instance Anda. Selain itu, setiap kali update tersedia, update tersebut akan diterapkan secara otomatis, memastikan versi API Explorer pada instance Anda adalah yang terbaru.
Jika admin Looker belum mengaktifkan opsi Instal Otomatis, Anda harus menginstal API Explorer dari Looker Marketplace.
Lihat halaman dokumentasi Menggunakan Looker Marketplace untuk mendapatkan petunjuk tentang cara menginstal ekstensi dari Looker Marketplace. Anda dapat memastikan bahwa API Explorer selalu diupdate ke versi terbaru dengan membuka Looker Marketplace, memilih Manage, lalu memilih tombol Update di samping ekstensi.
Memulai API Explorer
Setelah API Explorer terinstal, Anda dapat membukanya dari bagian Applications di sidebar kiri.
Menavigasi di API Explorer
Dari halaman beranda API Explorer, Anda dapat melakukan tugas berikut:
Gunakan drop-down pemilih bahasa SDK untuk memilih bahasa pemrograman yang akan digunakan API Explorer untuk menampilkan metode dan deklarasi jenis serta hasil kode API. Pemilih ditetapkan secara default ke Python saat pemuatan awal. Jika Anda memilih Semua dari pemilih bahasa, API Explorer akan menampilkan tampilan tab untuk setiap bahasa yang didukung.
Gunakan drop-down versi untuk memilih versi API:
- 4.0 - saat ini
Pilih tombol Bandingkan Spesifikasi untuk membuka halaman perbandingan versi API.
Masukkan istilah penelusuran di kolom Penelusuran untuk membatasi Metode dan Jenis yang tercantum hanya ke istilah yang menyertakan teks yang cocok dengan istilah penelusuran Anda.
Saat Anda memilih metode atau jenis yang ditampilkan oleh penelusuran, istilah penelusuran akan ditandai dalam metode atau ringkasan jenis.
Pilih tab Metode untuk menampilkan kategori metode API. Anda dapat memperluas atau mengontrak kategori metode untuk melihat setiap metode dalam kategori tersebut.
Pilih tab Types untuk menampilkan jenis API. Jenis tidak dikategorikan dan dicantumkan dalam urutan abjad.
Pilih tombol Menu Utama untuk menyembunyikan atau menampilkan panel navigasi API Explorer.
Melihat dokumentasi metode dan jenis API
Saat Anda memilih kategori metode di tab Metode, kategori metode akan diperluas dan menampilkan semua metode yang ada dalam kategori tersebut.
Semua metode yang ada dalam kategori tersebut ditampilkan di panel utama. Anda dapat memilih untuk menampilkan semua metode yang ada dalam kategori, atau Anda dapat memilih tab untuk jenis metode tertentu guna memfilter daftar hanya ke jenis metode tersebut.
Agar dapat melihat dokumentasi untuk metode tertentu, pilih nama metode di panel navigasi, atau pilih metode di panel utama.
Setelah Anda memilih metode tertentu, API Explorer akan menampilkan dokumentasi untuk metode tersebut.
Saat Anda memilih jenis dari tab Type, dokumentasi untuk jenis tersebut akan ditampilkan di panel utama.
Deklarasi metode dan jenis
API Explorer merender metode SDK dan deklarasi jenis dalam bahasa SDK yang dipilih di drop-down pemilih bahasa SDK. Jika pemilih bahasa SDK ditetapkan ke Semua, deklarasi metode dan jenis akan ditampilkan dalam semua bahasa SDK yang didukung, dipisahkan oleh tab.
Contoh SDK
Repositori sdk-codegen Looker memiliki folder yang berisi contoh Looker SDK. Jika repositori sdk-codegen memiliki contoh untuk suatu metode, halaman API Explorer metode akan menampilkan bagian Contoh SDK dengan link ke contoh tersebut.
Jika bahasa SDK tertentu dipilih, contoh untuk bahasa tersebut akan dicantumkan terlebih dahulu.
Mungkin juga ada contoh Ruby dan Java yang ditampilkan, meskipun ini bukan bahasa SDK.
Referensi
Bagian Referensi untuk setiap metode dan jenis akan menyertakan link ke halaman API Explorer untuk setiap metode atau jenis yang dirujuk oleh metode atau jenis asli.
Menggunakan Run It untuk meminta dan menampilkan panggilan API
API Explorer menyertakan tombol Run It yang membuka panel tempat Anda dapat meminta panggilan API dan menampilkan respons dalam berbagai format yang didukung.
Saat Anda memilih tombol Run It, API Explorer akan menampilkan tab Request, tempat Anda dapat memberikan input ke metode API.
Masukkan input yang diinginkan, lalu pilih Run untuk menjalankan panggilan API.
Setiap kali metode API dapat mengubah data (untuk panggilan REST apa pun yang berupa
POST,PATCH,UPDATE, atauDELETE), kotak centang konfirmasi perubahan data akan muncul dan harus dicentang sebelum permintaan dapat dijalankan.
Saat permintaan dijalankan, tab Response akan menampilkan hasilnya.
Selain itu, tab Kode menampilkan sintaksis panggilan SDK untuk SDK yang dipilih di drop-down pemilih bahasa. Jika pemilih bahasa SDK disetel ke Semua, sintaksis panggilan SDK akan ditampilkan dalam semua bahasa SDK yang didukung, dipisahkan oleh tab.
Jenis tampilan respons
Respons API Explorer menyertakan jenis MIME yang digunakan untuk menentukan cara menampilkan hasil.
CSV dan data tabel lainnya
Untuk data CSV dan JSON, Looker melakukan pengujian bentuk untuk menentukan apakah data memenuhi kriteria tabel. Jika Looker menentukan bahwa data payload berbentuk tabel, tampilan default untuk respons adalah petak data.
Pilih tab Raw untuk menampilkan data yang belum diubah.
JSON
Payload JSON mungkin berbentuk tabel, dan dalam hal ini akan ditampilkan dalam bentuk petak. Header kolom untuk kueri LookML ditampilkan dalam format <view_name>.<field_name>, bukan menampilkan label kolom.
Payload JSON yang kompleks menghilangkan tampilan petak dan hanya menampilkan JSON mentah.
PNG dan JPEG
Format PNG dan JPEG menampilkan visualisasi yang dipilih untuk kueri dan menyertakan setelan visualisasi yang diterapkan. Contoh berikutnya adalah output PNG dari kueri yang sama seperti yang ditampilkan sebelumnya, tetapi menggunakan visualisasi tabel. JPEG ditangani dengan cara yang sama.
SVG
Beberapa endpoint Looker menampilkan SVG, yang juga didukung secara langsung. Berikut adalah contoh endpoint content_thumbnail dalam format SVG, yang menampilkan gambar thumbnail dasbor yang diabstraksi.
HTML
Permintaan yang menampilkan kode sumber HTML akan menampilkan HTML sumber di tab Response.
Teks
Permintaan yang menampilkan SQL atau format lain yang diketik MIME sebagai teks biasa akan ditampilkan sebagai teks biasa di tab Response.
Membandingkan versi API
API Explorer menyertakan halaman yang memungkinkan Anda membandingkan berbagai versi Looker API untuk melihat perubahan antarversi. Pilih tombol berbentuk segitiga Bandingkan Spesifikasi, yang terletak di sudut kanan atas halaman, untuk membuka halaman perbandingan API Explorer.
Pilih versi dasar API dan versi API yang ingin Anda bandingkan dengan versi dasar.
Pilih opsi API yang ingin Anda sertakan dalam perbandingan untuk memfilter metode hanya untuk metode yang memiliki perbedaan dalam opsi yang Anda pilih. Opsinya adalah:
- Tidak Ada — Menampilkan semua metode yang ada dalam satu versi API dan yang tidak ada dalam versi lainnya.
- Status — Menampilkan semua metode yang status metodenya telah berubah. Misalnya, metode dengan status berubah dari
betamenjadistable. - Parameter — Menampilkan semua metode yang satu atau beberapa parameter metodenya telah berubah.
- Jenis — Menampilkan jenis yang memiliki properti baru, dihapus, atau diubah.
- Isi — Menampilkan perubahan pada parameter isi.
- Respons — Menampilkan semua metode yang mengalami perubahan pada respons metode.
Halaman perbandingan menunjukkan jumlah metode yang memiliki perbedaan dan mencantumkan metode yang memiliki perbedaan.
Pilih metode untuk meluaskannya, dan halaman perbandingan akan menampilkan perbedaan yang menunjukkan perubahan metode di antara versi.