Januari 28

Menggunakan Postman untuk Pengujian API

Ahad pagi merupakan hari yang sangat baik untuk berbagi kembali, sambil ditemani teh manis hangat dan tahu sumedang hangat. 😀

Pada artikel sebelumnya, kita sudah membahas bagaimana cara membuat Mock API dengan menggunakan tools mockapi.io. Bila teman-teman terlewat dengan artikel tersebut, teman-teman dapat membacanya kembali di sini :

Membuat Mock API dengan mockapi.io

Langkah selanjutnya adalah melakukan pengujian terhadap Mock API yang sudah kita buat tersebut tentunya. Nah, untuk pengujian ini, saya akan menggunakan Postman sebagai API Platform yang akan kita gunakan. Sebenarnya teman-teman dapat menggunakan API Platform Tools lainnya yang teman-teman sukai untuk melakukan pengujian API, namun saya pribadi sejak dahulu lebih senang menggunakan Postman sebagai API Platform yang saya gunakan, selain gratis, juga banyak fitur yang sangat bermanfaat untuk saya dapat gunakan.

Untuk Postman sendiri, teman-teman dapat mengunduhnya pada link berikut :

https://www.postman.com/downloads/

Adapun langkah-langkah pengujian Mock API dengan Postman sebagai berikut :

  • Buka Postman. Bila teman-teman baru pertama kali buka Postman, maka akan terlihat langkah untuk membuat sebuah Workspace baru. Teman-teman dapat memilih menggunakan template yang sudah disediakan oleh Postman. Namun, kali ini kita akan menggunakan Blank Workspace untuk pengujian kita kali ini. Kemudian klik tombol Next.

Postman Blank Workspace

  • Pada halaman ini, teman-teman diminta untuk mengisi nama workspace, keterangan perihal workspace tersebut, dan siapa yang akan mengakses workspace tersebut. Klik tombol Create untuk mulai membuat workspace.

Membuat Workspace Baru

  • Setelah workspace berhasil dibuat, teman-teman akan melihat tampilan Postman seperti berikut :

Blank Collection

  • Sebelum kita membuat collection, kita coba untuk membuat sebuah environment terlebih dahulu. Fungsi environment sendiri, agar memudahkan kita mengatur penggunaan collection untuk diuji pada environment yang berbeda. Kita klik tab Environments, kemudian klik icon + untuk membuat Environment baru.

Environments

  • Maka akan terbuat Environment baru. Isi nama Environment yang kita buat, bisa Local untuk lokal kita, Development untuk development kita, Staging, ataupun Production untuk masing-masing environment pada development project kita. Dikarenakan pada kali ini kita akan menguji Mock API, maka saya namakan environment kali ini Mock API. Isi variabel yang dibutuhkan, kemudian klik tombol Save.

Environment Baru

  • Setelah environment sudah dibuat, langkah selanjutnya kita sudah dapat membuat collection. Klik tab Collection, kemudian klik icon +. Maka akan tampil pilihan jenis collection yang ingin dibuat. Dikarenakan Mock API kita menggunakan RESTful API, maka kita pilih REST API basics, teman-teman dapat menyesuaikannya dengan kebutuhan project teman-teman.

Membuat Collection Baru

  • Maka akan tampil seluruh request untuk CRUD standard RESTful API.

CRUD Collection

  • Teman-teman dapat mengganti nama collection yang sudah dibuat dengan melakukan klik di tombol titik 3, kemudian klik Rename. Atau langsung dapat diklik pada Nama Collectionnya.

Rename Collection

  • Setelah collection dan semua request yang dibutuhkan sudah dibuat, kita sudah dapat menggunakan collection kita untuk pengujian API. Kita coba dengan salah satu request, klik request Get data, ubah endpoint info dengan endpoint yang ingin kita uji, kemudian pilih Environment yang sebelumnya kita buat, dan klik tombol Send. Tunggu sebentar sampai proses request selesai.

Get Data

Resource Products

Sampai sini kita sudah selesai membuat collection untuk melakukan pengujian API. Sisanya teman-teman dapat menyesuaikannya sesuai dengan kebutuhan project yang sedang dikerjakan.

Akhir kata, semoga artikel ini bermanfaat untuk teman-teman yang sedang membuat api untuk kebutuhan development project. Selamat berhari libur dan Terima Kasih. 😀

Januari 27

Membuat Mock API dengan mockapi.io

Sabtu pagi yang cerah, diiringi teh manis hangat, dengan gemericik suara hujan, merupakan waktu yang tepat untuk kita berbagi kembali. 😀

Untuk kali ini, kita akan mencoba membahas, bagaimana membuat sebuah mock api tanpa harus ribet coding dengan menampilkan response json berupa hardcode string. Cara ini memiliki beberapa keunggulan, di antaranya dapat mempercepat waktu development. Tentu saja, dengan membuat sebuah mock api, suatu tim yang bekerja dimana di dalamnya terdapat frontend, backend, bahkan mobile developer, maka masing-masing developer dapat bekerja secara paralel. Dimana baik frontend maupun mobile developer, tidak harus menunggu backend developer untuk menyelesaikan semua api nya, karena baik frontend maupun mobile developer, dapat melihat langsung request & response yang akan digunakan dalam development.  Dan untuk beberapa case, bahkan dapat mempercepat QA dalam mempersiapkan test case yang akan dibuatnya.

Sebenarnya ada banyak tools yang dapat digunakan untuk membuat sebuah mock api atau fake api. Namun pada pembahasan kali ini, kita akan menggunakan tools mockapi.io. Adapun langkah-langkah penggunaannya, sebagai berikut :

  • Buka mockapi.io dan buat akun serta login. Teman-teman dapat jg menggunakan akun google untuk langsung membuat akun dan login. Maka akan tampil kira-kira seperti berikut :

mockapi.io

  • Buat sebuah Project baru dengan meng-klik tombol +. Isi Name dengan nama project kita. Bila diperlukan untuk kebutuhan versioning api, bisa ditambahkan API Prefix. Kemudian klik tombol Create.

Tambah Project

  • Sampai pada tahap ini, project baru akan terdaftar berikut project-project lainnya bila teman-teman juga menggunakannya untuk banyak project.

Project List

  • Pilih project yang sudah kita buat tadi. Di sini akan terlihat base url dari mock api yang akan kita buat.

Resource List

  • Klik tombol New Resource untuk membuat sebuah resource api baru, maka akan tampil Popup New Resource. Buat skema api yang ingin kita buat. Nah, di sini kita bisa memanfaatkan Faker.js untuk generate random data terkait data apa yang ingin kita generate saat Mock API kita dipanggil. Teman-teman juga dapat membuatnya menjadi data statis. Jadi tergantung kebutuhan project nanti. Untuk response sendiri, bila teman-teman ingin membuatnya custom, misal dengan format sebagai berikut :

    Dimana $mockData merupakan data generate dari mockapi.io, maka teman-teman harus melakukan subscription terlebih dahulu dikarenakan untuk versi gratis, response yang diberikan akan langsung berupa data array hasil generate. Kemudian klik tombol Create.

Tambah Resource

  • Maka resource baru kita akan terlihat pada List Resource. Di sini kita dapat melakukan penyesuaian, berapa jumlah data yang akan kita generate. Maksimal jumlah data yang dapat kita generate adalah 100 buah.

Set Total Data

Generate 13 Data

  • Sebuah resource berhasil kita buat dan sudah siap untuk kita gunakan. Teman-teman juga dapat melihat contoh response yang akan dihasilkan dengan menekan tombol Data. Dan teman-teman juga dapat mengubah dan/atau menghapus resource tersebut dengan menekan tombol Edit dan/atau icon Delete.

Action Mock API

Data

Nah, sampai tahap ini, Mock API sudah berhasil kita buat untuk sebuah resource dan sudah siap untuk digunakan. Ada hal menarik yang perlu diperhatikan dalam penggunaan tool mockapi.io ini, dimana mockapi.io menerapkan secara menyeluruh perihal RESTful API. Bila teman-teman bingung bagaimana sebuah API secara penuh menerapkan RESTful API, teman-teman dapat membaca dokumentasi perihal RESTful API di sini (dan mungkin di lain kesempatan, kita akan coba bahas mengenai RESTful API) :

https://restfulapi.net/

Demikian pembuatan Mock API sudah selesai kita buat, mudah-mudahan bermanfaat buat teman-teman khususnya yang sedang kesulitan untuk mengatur waktu development para developer dalam tim. Akhir kata, kita habiskan teh hangat kita, semangat terus untuk bekerja, dan Terima Kasih. 😀

Juni 24

Menggunakan API Helper Swagger pada .Net Framework

Di malam yang sunyi ini, aku sendiri. Eh, ini mau menulis lirik lagukah? Tidaakkk…..

Maafkan ketidakjelasan saya, maklum malam ini saya sedang sendiri di rumah. Istri dan anak saya sedang menginap di rumah mertua.

Lanjut ke inti tulisan aja. Jadi, malam ini saya ingin membagikan ilmu, bagaimana cara menggunakan Swagger sebagai API Helper untuk project API kita. Untuk yang ingin mengetahui lebih lanjut apa itu Swagger, bisa buka link berikut :

https://swagger.io/

Selanjutnya, saya akan menjelaskan langkah-langkah yang perlu dilakukan untuk menggunakan Swagger ini. Sebelumnya perlu diingat, di sini saya coba mempraktekkan penggunaan Swagger untuk project API versi .Net Framework dan saya sendiri menggunakan .Net Framework 4.6.1 untuk tulisan ini. Berikut langkah-langkahnya :

  • Buat sebuah Project API, create nama project “API” dan tunggu hingga proses selesai seperti berikut :

Create Project API

  • Buka Package Manager Console dan pastikan project yang terpilih adalah project API yang akan dipasang Swagger. Lalu ketikkan perintah Install-Package Swashbuckle kemudian tekan enter. Tunggu hingga proses instalasi paket selesai :

Install Package

  • Pastikan SwaggerConfig sudah ada pada Folder App_Start seperti berikut :

SwaggerConfig

  • Buka property Project. Kemudian pilih Build. Aktifkan XML Documentation file dengan memberi tanda centang :

XML Documentation File

Proses pemasangan sudah berhasil sampai di sini. Selanjutnya kita dapat melakukan testing dengan menjalankan API kita. Dan saat sudah berjalan, kita tambahkan swagger pada path (untuk kasus saya, path menjadi berikut : http://localhost:57897/swagger) sehingga Swagger UI dapat terpanggil seperti berikut :

Testing Swagger

Jika kita klik pada List Operations, kita akan melihat semua endpoint/fungsi pada API kita dan melakukan testing pada setiap endpoint yang ingin kita tes.

List OperationsDemikian tutorial singkat saya pada malam ini. Harap dimaklum karena saya juga sepertinya sudah mulai mengantuk (maklum, ternyata sudah berganti hari, hehe…). Semoga tulisan ini bermanfaat khususnya bagi yang sedang mengerjakan project API namun bingung untuk menyiapkan sebuah UI untuk keperluan testing maupun sebagai dokumentasi project.

Nantikan artikel selanjutnya dan terima kasih… 😀