Sebagai pengembang API, Anda mungkin sudah familiar dengan Postman, alat populer untuk menguji dan mengotomatiskan permintaan API. Postman Newman telah menjadi alat andalan bagi banyak pengembang selama bertahun-tahun, tetapi bukan tanpa batasan.
Dalam panduan ini, kita akan membahas instalasi dan penggunaan Newman, alat baris perintah yang dirancang untuk menjalankan koleksi Postman. Dengan mengikuti panduan ini, Anda akan mempelajari cara menginstal Newman dan menjalankan koleksi Postman, memungkinkan Anda untuk mengotomatiskan proses pengujian API Anda. A merekomendasikan Apidog sebagai alternatif yang kuat.
Apa itu Newman di Postman?
Newman Postman adalah alat baris perintah yang memungkinkan pengembang untuk menjalankan koleksi dan lingkungan Postman dalam lingkungan integrasi berkelanjutan (CI). Postman adalah alat pengembangan API populer yang memungkinkan pengembang untuk merancang, menguji, dan mendokumentasikan API. Newman, di sisi lain, adalah alat yang memungkinkan pengembang untuk mengotomatiskan pengujian API menggunakan koleksi dan lingkungan Postman.
Dengan Newman Postman, pengembang dapat dengan mudah mengotomatiskan pengujian API dan memastikan bahwa API mereka berfungsi seperti yang diharapkan. Newman mendukung berbagai integrasi dan plugin, menjadikannya alat serbaguna untuk pengembangan API. Namun, ada beberapa batasan pada Newman Postman yang harus disadari oleh pengembang, seperti kompleksitasnya untuk menyiapkan dan mengonfigurasi eksekusi pengujian yang lambat dan biaya untuk penggunaan skala besar.
Apa Perbedaan Antara Newman dan Postman?
Postman dan Newman adalah alat pengembangan API, tetapi mereka melayani tujuan yang berbeda. Postman adalah aplikasi desktop yang memungkinkan pengembang untuk menguji API dengan antarmuka pengguna grafis (GUI). Newman, di sisi lain, adalah alat baris perintah yang memungkinkan pengembang untuk menjalankan koleksi dan lingkungan Postman dalam lingkungan integrasi berkelanjutan (CI), sehingga lebih mudah untuk mengotomatiskan pengujian API.
Perbedaan lain antara Postman dan Newman adalah biayanya. Postman memiliki versi gratis tetapi juga menawarkan paket berbayar dengan fitur tambahan. Newman, di sisi lain, adalah alat sumber terbuka yang gratis untuk digunakan.
Bagaimana Cara Menjalankan Koleksi Postman di Newman?
Menginstal Newman
Newman dibangun di atas Node.js. Untuk menjalankan Newman, pastikan Anda telah menginstal Node.js. Dan Node.js >= v16. Anda dapat menginstal Node.js dengan pengelola paket:
Menggunakan NPM adalah cara umum dan mudah untuk menginstal Newman. Masukkan perintah berikut di terminal.
npm install -g newman
Dengan menggunakan flag "-g", Newman akan diinstal secara global di sistem Anda, memungkinkan Anda untuk menjalankannya dari lokasi mana pun.
Menjalankan Koleksi Postman dengan Newman
Anda dapat menggunakan perintah "newman run" untuk menunjukkan koleksi mana yang akan dijalankan. Sangat mudah untuk mengekspor Koleksi Postman Anda sebagai file JSON dari Postman, dan kemudian menjalankannya menggunakan Newman.
newman run mycollection.json
Disarankan untuk Dibaca:
Tips Bonus Postman Newman
Menggunakan Newman dengan CI/CD
Newman keluar dengan kode status 0 secara default jika semuanya berjalan lancar tanpa pengecualian apa pun. Untuk memastikan bahwa alat integrasi berkelanjutan (CI) Anda merespons kode keluar Newman dan lulus atau gagal build yang sesuai, Anda dapat mengonfigurasinya sesuai dengan itu.
Selain itu, Anda dapat menggunakan flag "--bail" untuk membuat Newman menghentikan proses jika menemukan kesalahan kasus pengujian dengan kode status 1. Kesalahan ini kemudian dapat diambil oleh alat CI atau sistem build Anda dan ditindaklanjuti sesuai dengan itu.
Menggunakan Newman sebagai pustaka Node.js
Newman juga dapat digunakan sebagai pustaka Node.js, memungkinkan pengembang untuk mengintegrasikan pengujian API ke dalam aplikasi Node.js mereka. Dengan menggunakan Newman sebagai pustaka, pengembang dapat menjalankan koleksi secara terprogram, mengakses hasil pengujian, dan mengintegrasikan pengujian ke dalam proses build mereka.
const newman = require('newman'); // Import Newman module
async function runCollection() {
try {
await newman.run({
collection: require('./sample-collection.json'),
reporters: 'cli'
});
console.log('Collection run complete!');
} catch (err) {
console.error(err);
}
}
runCollection();
Contoh kode ini menggunakan sintaks async/await untuk membuat menjalankan Newman lebih ringkas dan mudah dibaca. Ini mengimpor modul Newman dan mendefinisikan fungsi asinkron bernama runCollection untuk menjalankan koleksi. Di dalam fungsi, ia menggunakan kata kunci await untuk menunggu Newman selesai berjalan, dan kemudian mencetak pesan yang menunjukkan bahwa koleksi telah dijalankan. Jika terjadi kesalahan, ia menangkap dan mencetak kesalahan tersebut. Akhirnya, ia memanggil fungsi runCollection() untuk menjalankan seluruh program.
Alternatif Postman Newman: Apidog
Apidog menyediakan dukungan untuk mengekspor skenario pengujian ke format Apidog CLI, Postman, dan JMeter, sehingga memudahkan untuk mengintegrasikan pengujian API ke dalam proses integrasi berkelanjutan Anda.
Apidog CLI dirancang khusus untuk menjalankan skenario pengujian Apidog di baris perintah, menyediakan cara yang efisien untuk menjalankan pengujian dan mengotomatiskan proses pengujian. Dengan mengekspor skenario pengujian ke Apidog CLI, pengembang dapat dengan mudah mengintegrasikan pengujian API ke dalam proses build mereka dan memastikan bahwa API diuji secara menyeluruh dan konsisten.
Selain Apidog CLI, Apidog juga mendukung ekspor skenario pengujian ke format Postman dan JMeter, memberikan pengembang fleksibilitas yang lebih besar dalam pendekatan pengujian mereka. Dengan opsi ekspor ini, pengembang dapat memilih alat pengujian yang paling sesuai dengan kebutuhan mereka dan mengintegrasikan pengujian API dengan mulus ke dalam alur kerja pengembangan mereka.
Cara Menginstal Apidog CLI
Prasyarat: Pertama, Anda perlu menginstal Node.js. Sebaiknya, versi >=v16.
Gunakan perintah di bawah ini untuk menginstal:
npm install -g apidog-cli
Anda dapat menginstal Apidog CLI secara global melalui npm di sistem Anda, memungkinkan Anda untuk menjalankannya dari lokasi mana pun.
npm install -g apidog-cliBerikut adalah beberapa perintah yang dapat Anda gunakan untuk mengonfirmasi apakah Apidog CLI telah berhasil diinstal.
node -v && apidog -v && which node && which npm && which apidogJika instalasi berhasil, menjalankan perintah di atas akan menampilkan nomor versi dan jalur instalasi segera.
Menjalankan dengan Data Waktu Nyata
Buka "tests," buka API yang Anda inginkan, dan beralih ke halaman CI/CD. Jika Anda belum memiliki skenario pengujian, buat saja.
Siapkan lingkungan, data pengujian, loop, interval, dan lainnya. Di penyedia CI/CD Anda, pilih "Command line" dan kemudian beralih ke "Run exported data." Di sini, Anda dapat memilih untuk menggunakan data yang diekspor oleh Newman.
Menjalankan Skenario Pengujian yang Diekspor
apidog run examples/sample.apidog-cli.json -r cli,html,json
Laporan pengujian akan disimpan ke direktori apidog-reports.
Jika Anda ingin menyesuaikan laporan, Anda dapat menggunakan hasilnya dalam file JSON untuk menyesuaikan laporan sesuai kebutuhan.
Anda juga dapat menemukan direktori /apidog-reports/ di folder tempat Anda menjalankan CLI. Direktori ini menyimpan laporan pengujian CLI dalam format HTML
Kesimpulan
Dengan mengikuti langkah-langkah yang diuraikan dalam panduan ini, Anda sekarang seharusnya memiliki pemahaman yang baik tentang cara menginstal dan menjalankan Newman untuk menjalankan koleksi Postman. Newman menyediakan antarmuka baris perintah yang memungkinkan pengujian API otomatis, menjadikannya alat yang berharga bagi pengembang yang bekerja di lingkungan integrasi berkelanjutan.
Namun, jika Anda mencari alternatif untuk Newman yang menawarkan solusi CI/CD yang lebih kuat, saya sangat menyarankan untuk mempertimbangkan Apidog. Selain antarmuka yang ramah pengguna untuk pengujian dan dokumentasi API, Apidog juga menyediakan fungsionalitas CI/CD yang kuat. Dengan fitur-fitur seperti mengekspor kasus pengujian, alat kolaborasi, pembuatan dokumentasi API otomatis, dan integrasi tanpa batas dengan alur CI/CD, Apidog menyediakan solusi komprehensif untuk kebutuhan pengembangan dan pengujian API.
Apakah Anda memilih untuk terus menggunakan Newman atau menjelajahi Apidog sebagai alternatif, kedua alat tersebut dapat sangat meningkatkan proses pengujian API Anda. Namun, jika Anda mencari solusi yang lebih komprehensif dengan fungsionalitas CI/CD yang kuat, Apidog pasti layak untuk dipertimbangkan.
