Buat dan konfigur alat

Mulai dengan dokumentasi API resmi untuk layanan bisnis dan tugas yang akun Anda diizinkan untuk melakukan. Satu alat yang sempit, digambarkan dengan baik lebih mudah untuk diuji daripada alat generik yang menerima URL dan metode arbitrer.

Tentukan permintaan#

Berikan alat nama stabil dan deskripsi yang menjelaskan tujuannya, batasan penting dan apakah ia mengubah data. Pilih metode HTTP yang terdokumentasi dan titik akhir. Gunakan tempat tinggal hanya untuk elemen variabel path yang operasi ini benar-benar mengizinkan.

Untuk pencarian rekaman fiktif, path mungkin berisi identifikator rekaman. Nama host dan wilayah akun harus tetap menjadi bagian dari koneksi yang dikonfigurasi daripada masukan model terbuka.

Menentukan dan memetakan masukan#

Gunakan skema masukan untuk menggambarkan setiap medan, jenisnya, status yang dibutuhkan dan nilai yang valid. Skema kecil untuk pencarian fiktif adalah:

{
  "type": "object",
  "properties": {
    "record_id": {
      "type": "string",
      "description": "The verified identifier of the record to read"
    }
  },
  "required": ["record_id"],
  "additionalProperties": false
}

Peta argumen ke path terdokumentasi, pertanyaan atau tubuh medan. Periksa bahwa hilangnya medan yang diperlukan dan argument tambahan yang tidak diharapkan gagal dengan jelas. Simpan otentikasi pada sambungan server yang didukung, bukan pada prompt, contoh skema atau header alat terkode keras.

Bentukkan keluaran#

Pemetaan atau transformasi respon dapat mengembalikan bidang yang diperlukan oleh aliran kerja daripada seluruh respon layanan. Verifikasi keluaran yang diubah dengan hasil tes asli. Jangan hapus identifikator rekaman, informasi paginasi atau rincian kesalahan yang diperlukan untuk memahami apakah hasil lengkap.

Tinjau pengaturan operasi#

Konfigurasi alat mendukung pengaturan waktu habis, penyimpanan cache dan coba ulang. Gunakan penyimpanan cache hanya bila data lama dapat diterima; bacaan yang disimpan cache tidak cocok sebagai bukti akhir bahwa penulisan baru selesai. Melakukan ulang penulisan yang tidak efektif dapat membuat duplikat, jadi pilih perilaku coba ulang dari jaminan yang terdokumentasikan API.

Uji jalur sebenarnya#

Periksa masukan yang benar, masukan yang tidak sah, hasil kosong, kegagalan izin dan panggilan sukses yang dibatasi. Diagnostik uji mungkin berisi informasi permintaan sensitif; periksa mereka hanya melalui rute administrator yang disetujui dan redig sebelum berbagi. Lihat pengujian sebelum klien menggunakan alatnya.