Cara Membuat Contoh API Method GET dan POST di Apiary

Mumpung hari libur nih, saya mau membagi sebuah materi tentang cara membuat API method POST dan GET. API saya buat di sebuah website yang mempesilitasi kita membuat sebuah dummy API. Nama website tersebut adalah apiary.io, bisa kalian browsing di google.

Saya tau sebagai seorang developer Android sangat perlu sekali bagi kita untuk menguasai beberapa hal yang berhubungan dengan pembuatan aplikasi, misalnya kita akan membuat sebuah aplikasi penyimpanan, kita harus paham tentang syntax-syntax SQL.
Selain SQL kita juga harus paham bagaimana cara membuat sample API, bagaimana format jsonnya dan bagaimana strukturnya. Pemahaman tentang API sangat penting dalam memperlancar kita untuk develop aplikasi jika server backend belum siap dengan APInya.

Saya belajar API di apiary ini sendiri, nanya sana sini dan akhirnya sekarang sudah bisa buat sample API sendiri, lumayan sangat terbantu dalam develop aplikasi. Mari kita mulai satu persatu

Ketika kalian masuk ke apiary pertama kali, kalian sudah dikasi sample API dengan Method GET, kalian tinggal edit file tersebut. Tapi disni saya buat dari awal saja ya, biar enak menjelaskannya dan sama sama mengerti.

1. FORMAT dan METHOD
 
FOTMAT dan HOST isikan default apa adanya saja yaitu FORMAT : 1A, HOST : http://polls.apiblueprint.org/ 

 2. TANDA PAGAR SATU (#)

Tanda # (Hanya satu tanda pager) digunakan untuk memberikan nama API yang kita buat, misalnya saya mau buat API tentang profile saya, kalian tinggal tulis #PROFILE SAYA. Kalian bisa isikan diskripsi tentang API tersebut dibawah, contohnya seperti berikut :

#PROFILE SAYA
API ini menyimpan detail semua profile saya, baik itu berdasarkan idsekolah maupun idkerja atau bla bla bla

3. TANDA PAGAR DUA (##) 

Tanda pagar 2 (##) adalah diskripsi tentang URL kalian nantinya setelah tanda “/”, misalnya begini kalian punya url www.putuguna.com, oleh tanda pagar dua menjadi begini outputnya www.putuguna.com/urlkalian. Cara pembuatannya begini :

## URL Get My Profile  [/profle]
kalian juga bisa isikan deskripsi apa saja disini

4. TANDA PAGAR TIGA (###)

Tanda pagar tida (###) digunakan untuk menentukan sample API yang kita buat itu POST atau GET, contohnya kita akan membuat method GET

### Get my profle [GET]

 Atau dengan method POST

### Login User [POST]

Itu beberapa hal yang perlu kalian perhatikan lebih dahulu sebelum memulai menulis API dengan Method GET atau POST. Lalu bagaimana membuat API dengan method tertentu? Begini caranya.

METHOD GET

Method GET sendiri terdapat dua macam URL nya. Pertama ada yang biasa yaitu “/urlkalian“, yang kedua dengan menggunakan paramter “/urlkalian?id=1

METHOD GET DENGAN PARAMETER

Saya sudah jelaskan diatas untuk membuat url dibelakang tanda / kita menggunakan tanda pagar dua (##), makan untuk membuat url dengan paramter caranya begini :

 ## URL Get My Profile [/profile{id}]

 Url diatas akan meng GET profile berdasarkan ID. Output URLnya menjadi seperti ini : www.website.com/profile?id. Lengkapnya begini :

API yang saya buat ini sudah saya terapkan di contoh postingan tentang Get data di Retrofit 2.0

METHOD GET TANPA PARAMETER

Jika tanpa parameter, penulisan URL nya seperti berikut ini :

## URL Get My Profile [/profile]

URL nya simple tanda embel-embel ID seperti pada GET dengan parameter, Json lengkapnya seperti ini :

METHOD POST

Method POST tidak menggunakan parameter seperti halnya method GET, tapi menggunakan Body. Kalian juga tidak bisa melihat komponen jsonya hanya dengan paste URL di browser. Kenapa tidak bisa? Karena dy itu Method POST, salah satu cara melihatnya dengan menggunakan POSTMAN, gunakan method POST terus lihat dibawahnya ada body, nah isikan apa-apa saja paramternya.

Cara memuat method POST di apiary adalah :

## Data Login [/loginsaya]
## Input Login [POST]

 
Lengkapnya seperti dibawah ini :
API ini pernah saya gunakan pada postingan saya yang berjudul Cara Post Data Menggunakan Retrofit 2

Beberapa hal penting yang harus diperhatikan agar tidak bingung menggunakan API yang sudah kalian buat.

Editor API ada disebelah kiri, sedangkan outpunya bisa kalian di sebelah kanannya, nanti kalian bisa lihat sample API yang kalian buat.

klik yang dikotakin hitam

Setelah kalian klik yang dikotakin tersebut, kalian akan dibawah masuk ke sample servernya. Untuk dapat menggunakan API ini, kalian gunakan saja Mock Server biar gampang proses penggunaanya.

Klik TRY maka kalian akan dapatkan URL mock servernya, kalian bisa gunakan itu di aplikasi kalian

Sekian artikel tentang pembuat API di apiary.io, semoga membantu kalian dalam belajar.

(Visited 219 times, 1 visits today)

About The Author

Berlangganan Artikel

Untuk mendaftarkan tutorial pemrograman terbaru dari putuguna[dot]com, silakan tuliskan email kalian dibawah ini