Pemecahan masalah penggunaan API

Halaman ini menyajikan ringkasan tentang cara memecahkan masalah penggunaan Google API dan Google Cloud API kepada developer aplikasi.

Latar belakang

Google API adalah API berjaringan yang disediakan oleh layanan Google. Aplikasi dapat mengakses Google API melalui HTTP JSON dan gRPC dari berbagai lingkungan. Sebaiknya developer menggunakan library klien yang disediakan Google dalam aplikasi mereka. Library ini menerapkan logika boilerplate umum, seperti autentikasi dan penomoran halaman daftar, yang sangat mengurangi overhead pengembangan dan kesalahan umum.

Untuk informasi selengkapnya, lihat Penjelasan Library Klien

Memulai

Jika baru menggunakan Google API, Anda harus mengikuti halaman Memulai untuk menyelesaikan langkah-langkah persiapan untuk aplikasi Anda. Anda harus terlebih dahulu menggunakan perintah curl -v untuk mengirim permintaan pengujian ke Google API yang ingin Anda gunakan. Solusi ini memungkinkan Anda bereksperimen dengan Google API tanpa perlu menulis kode apa pun. Anda sering kali dapat menyelesaikan banyak masalah sebelum memulai pengembangan aplikasi yang sebenarnya.

Untuk informasi selengkapnya, lihat Memulai.

Pemecahan masalah menggunakan metrik

Google API menyediakan metrik API gratis yang mencakup aspek umum penggunaan API, termasuk jumlah permintaan, error, latensi, ukuran permintaan, dan respons. Template ini memberikan dimensi terperinci dalam hal penerapan dan lokasi. Developer dapat menemukan penggunaan API yang tidak normal, dan mengidentifikasi kemungkinan akar penyebab. Misalnya, error 400 yang lebih tinggi dapat berarti aplikasi yang baru diupdate memiliki beberapa bug logis, atau ukuran permintaan dan respons yang lebih tinggi dapat menyebabkan performa aplikasi yang lebih lambat.

Untuk informasi selengkapnya, lihat Monitoring API usage.

Pemecahan masalah menggunakan log

Karena alasan keamanan dan privasi, Google API umumnya tidak memberikan log API kepada developer aplikasi. Sebaiknya developer aplikasi membuat log error API di sisi klien. Anda dapat mencatat error ke dalam log di penyimpanan lokal atau ke API logging jarak jauh, seperti Cloud Logging API.

Log biasanya berisi lebih banyak informasi tentang error daripada metrik, seperti pesan error dan detail error. Solusi ini sangat berguna dan sering kali diperlukan untuk memecahkan masalah error API. Saat melihat masalah apa pun dengan penggunaan API, developer dapat membuat kueri log untuk menemukan pesan error dan detail error, serta menggunakan informasi tersebut untuk mengatasi error atau menghubungi dukungan.

Cloud Audit Logs

Untuk aktivitas yang sensitif terhadap keamanan, produk Google Cloud dapat membuat log audit yang berisi informasi mendetail tentang aktivitas. Laporan ini adalah sumber informasi yang bagus untuk memecahkan masalah penggunaan Google Cloud API. Misalnya, fitur uji coba Kontrol Layanan VPC menghasilkan log audit untuk administrator guna mengevaluasi perubahan kebijakan yang akan datang.

Untuk mengetahui informasi selengkapnya, lihat Log Audit Cloud.

Menyelesaikan error

Jika Anda mengalami masalah dengan penggunaan Google API dan telah menemukan metrik dan log yang sesuai, ikuti halaman Error dalam Panduan Desain API untuk mengatasi error.

Secara umum, setiap error API memiliki 3 informasi: kode error, pesan error, dan detail error:

  • Kode error memungkinkan aplikasi menangani error pada tingkat yang lebih tinggi, seperti percobaan ulang setelah error 503 atau autentikasi ulang pengguna setelah error 401.

  • Pesan error memungkinkan developer aplikasi memahami error dan memperbaiki logika aplikasi mereka.

  • Detail error berisi informasi tambahan yang dapat digunakan aplikasi untuk menangani error secara terprogram.

Untuk mengetahui informasi selengkapnya, lihat halaman Error.