Infomasakini

Membahas Mobil Legends, Biodata Pro Player, Youtuber Gaming, Tutorial,Coding, Tips Trick and Tekhnologi

Thursday, 27 June 2019

Cara Membuat Dokumentasi API Request Response di Postman, Sangat MUDAH!

Cara Membuat Dokumentasi API Request Response di Postman - Halo sobat bloger , sudah lama tidak update tentang dunia tekhnologi, nah pada kesempatan kali ini saya akan  memberikan nih tips atau tutorial Cara Membuat Dokumentasi API Request Response di Postman, belum tau API? API adalah sekumpulan fungsi atau perintah untuk melakukan pertukaran data untuk 2 aplikasi atau lebih, biasanya API megeluarkan data dengan format JSON, ya kelebihan menggunakan  API adalah kita bisa melakukan pertukaran data tanpa terhambat oleh platform yang di gunakan,  bagi seorang developer atau programmer khusunya bagian Backend menguji sebuah API sangatlah penting , entah itu itu API dari pihak 3 atau vendor ataupun API yang di buat sendiri, dengan menguji/testing request dan response yang di hasilkan bisa kita sesuaikan sesuai kebutuhan, karena semakin terstrukruktur API maka untuk mengkonsumsinya pun akan semakin mudah,


untuk melakukan testing terhadap api di permudah dengan tools tools yang memang khusus untuk menguji API, seperti POSTMAN atau Insomnia, 2 aplikasi ini hampir mirip, namun seperti judul artikel ini , kita hanya fokus pada postman, apasih sebenarnya postman itu? POSTMAN adalah sebuah tools/aplikasi yang berfungsi sebagai REST Client dan digunakan untuk menguji API API yang telah kita buat. fitur dari postman pun ada banyak seperti Sharing Collection API for Documentation (free), Testing API (free), Realtime Collaboration Team (paid), Monitoring API (paid), Integration (paid) dan lain lain , nah pada kasus kali saya akan membagikan cara mempublish dokuementasi API mulai dari Request dan Response yang di hasilkan, penasarakan kan? caranya sangat mudah sekali kok


  • Langkah pertama tentu kalin masuk dulu ke dalam aplikasi POSTMAN kalian dan pastikan(sebagi contoh) ada satu endpoint yang sudah bisa di jalankan(memiliki request dan response), contoh dibawah
  • Silahkan jalankan url tersebut sampai berhasil megeluarkan output(response)

  • jika sudah sekarang scroll ke atas aplikasi di atas tombol SAVE , ada link example

  • klik add example kemudian klik save, jika kamu memiliki 10 url endpoint silahkan lakukan itu semua ke 10 url tersebut, namun untuk contoh 1 juga tidak apa apa  *sudah memiliki output(response)
  • Save Example
  • sekarang menuju ke folder API kalian , klik icon 3 titik yang saya beri garis panah lalu klik "Publish Docs"
  • kamu akan dibawa ke halaman web, dari postman kamu, mengatur style disini namun ini bersifat opsional, scroll ke bawah dan klik "Publish Collection"
  • nah kamu akan di beri sebuah link, pada step ini dokumentasi API sudah bisa lihat, kamu hanya perlu mengklik Link yang di beri tadi

  • dan tadaaa, Sebuah request dan response sudah berhasil di dokumentasikan dan sekarang bisa kamu ke sebarkan ke bagian yang membutuhkan


bagaimana mudahkan , nah itu adalah Cara Membuat Dokumentasi API Request Response di Postman, mungkin sharing kali ini cukup sampai disini saja , oh ya jangan lupa sharea yang jika artikel ini bermanfaat , sampai jumpa and see you!

No comments:

Post a Comment