Cara Menguji ASP.NET Core Web API Menggunakan Postman

Di artikel ini, kita akan membahas cara menguji ASP.NET Core Web API menggunakan Postman. Sebelumnya, pastikan Anda telah membaca artikel kami yang membahas cara membuat, membangun, menjalankan, dan menguji aplikasi ASP.NET Core Web API. Artikel ini merupakan kelanjutan dari artikel sebelumnya. Postman adalah alat klien yang digunakan untuk menguji API Restful.

Postman dalam Proyek ASP.NET Core Web API

Menggunakan Postman dan Swagger untuk menguji layanan Web API merupakan praktik umum dalam pengembangan perangkat lunak. Postman dan Swagger adalah dua alat yang sangat kuat yang memungkinkan Anda untuk berinteraksi dengan dan menguji API Anda. Dalam artikel ini, saya akan menjelaskan cara menggunakan Postman, dan pada artikel berikutnya, saya akan membahas cara menguji ASP.NET Core Web API menggunakan Swagger. Berikut adalah panduan langkah demi langkah untuk menguji proyek Web API Anda menggunakan Postman:

Langkah 1: Menginstal Postman

Jika Anda belum menginstal Postman, unduh dan instal Postman dari situs resmi https://www.postman.com/downloads/.

Langkah 2: Menjalankan Postman

Setelah Postman diinstal, buka aplikasi Postman di komputer Anda.

Langkah 3: Mengimpor Dokumentasi API

Jika Anda memiliki spesifikasi OpenAPI (sebelumnya dikenal dengan spesifikasi Swagger) untuk API Anda, Anda dapat mengimpornya ke dalam Postman. Klik “Import” di aplikasi Postman dan pilih opsi untuk mengimpor dari file. Pilih file spesifikasi OpenAPI Anda (biasanya dalam format JSON atau YAML) dan impor ke Postman.

Langkah 4: Jelajahi Dokumentasi API

Setelah diimpor, Anda dapat menjelajahi dokumentasi API di dalam Postman. Dokumentasi ini akan menampilkan semua endpoint yang tersedia, metode request (GET, POST, PUT, DELETE, dll.), parameter request, header, dan struktur respons.

Langkah 5: Kirim Permintaan

Untuk menguji API Anda, pilih endpoint dari dokumentasi, pilih metode HTTP yang sesuai, dan klik tombol “Send”. Postman akan mengirimkan permintaan ke URL yang ditentukan dengan parameter yang diberikan.

Langkah 6: Periksa Respons

Postman akan menampilkan respons yang diterima dari API. Anda dapat memeriksa kode status, header respons, dan body respons. Anda juga dapat menggunakan alat bawaan Postman untuk memformat dan memvalidasi data respons.

Cara Menguji ASP.NET Core Web API Menggunakan Postman

Sekarang, mari kita lihat cara menguji ASP.NET Core Web API menggunakan Postman. Pertama, buka Postman. Setelah membuka Postman, klik tombol "New" untuk membuat permintaan baru.

Langkah 1: Membuat Permintaan Baru Setelah mengklik tombol “New”, jendela “Create New” akan terbuka. Klik pada tab "Request" seperti yang ditunjukkan gambar di bawah.

Langkah 2: Simpan Permintaan Setelah mengklik tombol "Request", jendela "Save Request" akan terbuka. Di sini, Anda perlu memberikan nama yang bermakna untuk permintaan API Anda dan menyediakan deskripsi API. Anda juga perlu membuat koleksi tempat Anda akan menyimpan permintaan ini, atau Anda dapat menggunakan koleksi yang sudah ada. Dalam contoh ini, saya membuat koleksi baru seperti yang ditunjukkan gambar di bawah.

Langkah 3: Pilih Metode HTTP Pilih metode HTTP yang sesuai untuk API yang ingin Anda akses. Di dropdown, Anda akan menemukan daftar metode HTTP yang tersedia. Sesuai kebutuhan Anda, pilih GET, POST, PUT, PATCH, DELETE, dll. Dalam contoh ini, API WeatherForecast menggunakan metode GET, jadi pilihlah metode GET di sini.

Langkah 4: Masukkan URL Permintaan Pada kolom "Enter Request URL", masukkan URL API yang ingin Anda akses, seperti yang ditunjukkan gambar di bawah. Untuk mengakses API WeatherForecast, masukkan URL https://localhost:5001/WeatherForecast.

Langkah 5: Parameter (Jika Ada) Jika API Anda membutuhkan parameter, Anda perlu mengatur parameter tersebut dalam bentuk pasangan key-value di tab Params. Dalam contoh ini, kita tidak akan mengirimkan parameter ke Web API, sehingga kolom ini dibiarkan kosong.

Langkah 6: Otorisasi (Jika Diperlukan) Jika Web API Anda memerlukan otorisasi, Anda harus menyediakan otorisasi tersebut di sini. Pilih jenis otorisasi yang sesuai di tab jenis dan masukkan nilai untuk otorisasi tersebut. Pada contoh ini, kami tidak memerlukan otorisasi, jadi kolom ini dibiarkan kosong.

Langkah 7: Header Tab selanjutnya adalah tab Headers. Secara default, Postman akan mengirimkan beberapa header ke Web API. Jika API Anda membutuhkan header tambahan, Anda dapat menambahkannya di sini dalam bentuk pasangan key-value. Pada contoh ini, API tidak memerlukan header tambahan, jadi kita hanya menggunakan header default.

Langkah 8: Body Jika API Anda menerima data dalam body, Anda bisa mengirimkan data tersebut di tab Body. Tergantung pada jenis data, Anda bisa memilih form-data, raw, binary, dll., seperti yang ditunjukkan pada gambar di bawah. Karena API kami adalah permintaan GET dan tidak memerlukan data, kolom ini dibiarkan kosong.

Langkah 9: Kirim Permintaan Klik tombol “Send” yang akan mengirimkan permintaan ke server Web API, seperti yang ditunjukkan pada gambar di bawah.

Langkah 10: Periksa Respons Setelah mengklik tombol “Send”, permintaan akan dikirim ke Web API, dan Web API akan mengirimkan respons kembali ke klien. Anda dapat melihat respons di body respons, seperti yang ditunjukkan gambar di bawah.

Di respons, Anda juga dapat memeriksa kode status HTTP, waktu yang dibutuhkan, dan ukuran data yang diterima, seperti yang ditunjukkan pada gambar di bawah.

Kesimpulan

Begitulah cara menggunakan Postman untuk menguji Web API Anda.  Di artikel ini, saya mencoba menjelaskan cara menggunakan Postman untuk menguji ASP.NET Core Web API, dan saya berharap Anda menikmati artikel ini tentang penggunaan Postman dalam ASP.NET Core Web API.