Tutorial EchoAPI: Cara Menggunakan Skrip dalam EchoAPI

Dalam tutorial ini, kami akan meneroka cara menggunakan skrip dalam EchoAPI untuk ujian dan pembangunan API lanjutan. Skrip EchoAPI, yang ditulis dalam JavaScript, membolehkan anda menambah fungsi dinamik pada permintaan API anda. Dengan memahami kedua-dua skrip pra-pelaksanaan dan pasca-pelaksanaan, anda boleh meningkatkan keupayaan ujian anda, mengurus pembolehubah dan memanipulasi parameter permintaan dengan mudah. Mari selami ciri hebat skrip EchoAPI dan lihat cara ia boleh menyelaraskan aliran kerja API anda.

Apakah Skrip EchoAPI?

Skrip EchoAPI ialah coretan kod berdasarkan JavaScript yang membolehkan anda menambah gelagat dinamik semasa permintaan API atau ujian pengumpulan.

Fungsi Skrip EchoAPI

Skrip boleh mencapai fungsi berikut:

• Uji (Tegaskan) ketepatan keputusan respons permintaan (skrip selepas pelaksanaan).
• Ubah suai parameter permintaan API secara dinamik, seperti menambahkan parameter tandatangan API (Skrip prapelaksanaan).
• Haluskan data antara permintaan API (Menggunakan pembolehubah dalam skrip).
• Buat permintaan terus ke titik akhir API dalam skrip.

Skrip EchoAPI dibahagikan kepada skrip pra-pelaksanaan dan pasca-pelaksanaan.

Skrip Pra-Pelaksanaan

Skrip pra-pelaksanaan dilaksanakan sebelum permintaan dihantar.

Skrip Selepas Perlaksanaan

Skrip selepas pelaksanaan dilaksanakan selepas permintaan dihantar.

Contoh Penyerahan Sebenar

Seperti yang ditunjukkan dalam rajah di bawah (output konsol), skrip pra-pelaksanaan berjalan sebelum permintaan dihantar dan skrip pasca pelaksanaan berjalan selepas permintaan selesai:

Fungsi Skrip Pra-Pelaksanaan

Skrip pra-pelaksanaan mempunyai beberapa fungsi utama:

• Lakukan pengiraan kompleks menggunakan fungsi JS.
• Cetak nilai pembolehubah.
• Takrif, dapatkan semula, padam dan kosongkan pembolehubah persekitaran.
• Tentukan, dapatkan semula, padam dan kosongkan pembolehubah global.
• Parameter permintaan akses.
• Tambah atau alih keluar parameter pengepala secara dinamik.
• Tambah atau alih keluar parameter pertanyaan secara dinamik.
• Tambah atau alih keluar parameter badan secara dinamik.
• Hantar permintaan HTTP.

Sebagai contoh, kita boleh mentakrifkan fungsi _rawak dalam skrip pra-pelaksanaan:

function _random() {
    return 'Hello, EchoAPI ' + Math.random();
}

Fungsi ini mengembalikan rentetan: "Hello, EchoAPI" diikuti dengan nombor rawak. Kami kemudiannya boleh menetapkannya kepada pembolehubah global random_var seperti berikut:

pm.globals.set("random_var", _random());

Mencetak Pembolehubah Nyahpepijat dalam Skrip Pra-Pelaksanaan

Kita boleh menggunakan console.log() untuk mencetak pembolehubah yang diperlukan ke konsol dan melihat nilai semasa pembolehubah tersebut.

Menguruskan Pembolehubah Persekitaran

• Menetapkan pembolehubah persekitaran:

  pm.variables.set("key", "value"); // Set an environment variable 'key' with value 'value'

• Mendapatkan semula pembolehubah persekitaran:

  pm.variables.get("key"); // Get the value of the environment variable 'key'

• Memadamkan pembolehubah persekitaran:

  pm.variables.delete("key"); // Delete the environment variable 'key'

• Mengosongkan semua pembolehubah persekitaran:

  pm.variables.clear(); // Clear all defined environment variables

Menguruskan Pembolehubah Global

• Menetapkan pembolehubah global:

  pm.globals.set("key", "value"); // Set a global variable 'key' with value 'value'

• Mendapatkan semula pembolehubah global:

  pm.globals.get("key"); // Get the value of the global variable 'key'

• Memadamkan pembolehubah global:

  pm.globals.delete("key"); // Delete the global variable 'key'

• Mengosongkan semua pembolehubah global:

  pm.globals.clear(); // Clear all defined global variables

Mengakses Parameter Permintaan

Parameter permintaan boleh diakses melalui objek permintaan. Untuk butiran lanjut, rujuk bahagian "Pembolehubah Terbina Dalam EchoAPI".

Mengurus Parameter Permintaan Secara Dinamik

• Menambah parameter pengepala:

  pm.setRequestHeader("key", "value"); // Dynamically add a header parameter with key 'key' and value 'value'

• Mengalih keluar parameter pengepala:

  pm.removeRequestHeader("key"); // Remove the header parameter with key 'key'

• Menambah parameter pertanyaan:

  pm.setRequestQuery("key", "value"); // Dynamically add a query parameter

• Mengalih keluar parameter pertanyaan:

  pm.removeRequestQuery("key"); // Remove the query parameter with key 'key'

• Menambah parameter badan:

  pm.setRequestBody("key", "value"); // Dynamically add a body parameter

• Mengalih keluar parameter badan:

  pm.removeRequestBody("key"); // Remove the body parameter with key 'key'

Menghantar Permintaan HTTP dalam Skrip Pra-Pelaksanaan

Anda boleh menghantar permintaan HTTP menggunakan kaedah $.ajax() AJAX dalam skrip pra-pelaksanaan. Berikut ialah contoh mudah di mana permintaan dihantar ke https://echo.apipost.cn/get.php, dan bigint respons diberikan kepada bigint pembolehubah global:

function _random() {
    return 'Hello, EchoAPI ' + Math.random();
}

Fungsi Skrip Selepas Pelaksanaan

Skrip selepas pelaksanaan dilaksanakan selepas permintaan dihantar dan boleh melaksanakan banyak fungsi yang sama seperti skrip pra-pelaksanaan, termasuk:

• Lakukan pengiraan kompleks menggunakan fungsi JS.
• Cetak nilai pembolehubah.
• Takrif, dapatkan semula, padam dan kosongkan pembolehubah persekitaran.
• Tentukan, dapatkan semula, padam dan kosongkan pembolehubah global.
• Permintaan akses dan parameter respons.
• Hantar permintaan HTTP.
• Uji (Tegaskan) ketepatan keputusan respons permintaan.

Kaedah untuk mentakrif, mendapatkan semula, memadam dan mengosongkan persekitaran serta pembolehubah global adalah sama seperti yang terdapat dalam skrip pra-pelaksanaan dan tidak akan diulang di sini.

Menerima Parameter Respons

Anda boleh mengakses parameter respons melalui objek respons. Untuk operasi terperinci, rujuk bahagian "Pembolehubah Terbina Dalam EchoAPI".

Menguji Kesahan Respons Permintaan

Anda boleh menggunakan skrip pasca pelaksanaan untuk menguji (menegaskan) ketepatan keputusan respons permintaan.

Kesimpulan

Ringkasnya, skrip EchoAPI menawarkan cara yang mantap untuk meningkatkan proses pengujian dan pembangunan API anda. Dengan memanfaatkan kedua-dua skrip pra-pelaksanaan dan pasca-pelaksanaan, anda boleh mengurus parameter permintaan secara dinamik, menegaskan kesahihan tindak balas dan menggunakan pembolehubah dengan berkesan. Fungsi ini bukan sahaja menyelaraskan proses ujian tetapi juga membolehkan operasi yang lebih kompleks, menjadikannya lebih mudah untuk memastikan ketepatan dan kecekapan penyepaduan API anda. Mula melaksanakan skrip EchoAPI hari ini dan tingkatkan pengalaman ujian API anda!

Atas ialah kandungan terperinci Tutorial EchoAPI: Cara Menggunakan Skrip dalam EchoAPI. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!