Apa itu REST API
REST adalah singkatan dari Representational State Transfer, sedangkan API singkatan dari Aplication Programming Interface.
Secara Sederhana REST artinya sebuah standar yang sudah ditetapkan, dan API adalah sebuah perantara untuk berkomunikasi, jadi REST API adalah perantara untuk komunikasi yang memenuhi standar REST.
Sekarang bagaimana standar REST itu?
ciri-ciri utama dari REST API adalah memiliki http method dan status code.
berikut merupakan list dari method nya:
GET
- GET = read, membaca
PUT
- PUT = update, memperbarui/mengedit
DELETE
- DELETE = remove, menghapus
POST
- POST = create, membuat baru
setelah method dikerjakan, harus ada status code nya dalam arti status code berfungsi sebagai informasi yang di berikan ketika method selesai dikerjakan, bisa jadi sukses atau gagal atau lainnya.
berikut merupakan list dari status code nya:
200 OK
- Status sukses secara umum, status ini yang paling sering digunakan untuk mengindikasi method sukses.
201 CREATED
- Status sukses/berhasil membuat, umumnya digunakan pada method POST atau PUT.
204 NO CONTENT
- Status sukses tetapi respon body-nya kosong, umumnya status ini digunakan pada method DELETE atau PUT.
400 BAD REQUEST
- Status gagal secara umum , status ini yang paling sering digunakan apabila request salah atau data hilang.
401 UNAUTHORIZED
- Status gagal , status ini digunakan apabila error disebabkan oleh autentikasi token yang tidak valid atau hilang.
403 FORBIDDEN
- Status gagal, status digunakan ketika user tidak ada izin untuk melakukan operasi atau tidak lolos authorized.
404 NOT FOUND
- Status gagal, status ini digunakan ketika requestnya tidak ditemukan, bisa karena item yang di request tidak ada atau karena error di 401/403 yang untuk alasan keamanan disembunyikan oleh layanan.
405 METHOD NOT ALLOWED
- Status gagal, status ini digunakan untuk menunjukkan bahwa URL yang diminta ada, tapi metode HTTP yang diminta tidak berlaku.
409 CONFLICT
- Status gagal, status ini digunakan ketika memenuhi permintaan tapi tidak support. Contohnya entri duplikat, yaitu mencoba membuat dua pelanggan dengan informasi yang sama.
500 INTERNAL SERVER ERROR
- Status gagal, status ini menangkap error yang umum yang terjadi ketika semua sisi server melempar pengecualian, status ini hanya digunakan untuk kesalahan yang belum bisa diatasi .
ciri-ciri REST API berikutnya adalah memiliki dokumentasi.
berikut contoh dokumentasi REST API menggunakan Markdown
Setelah REST API selesai dibuat kita ingin mencoba apakah REST API yang kita buat sudah berjalan dengan semestinya.
Salah satu cara yang direkomendasikan untuk mengetes REST API yang telah kita buat adalah dengan menggunakan POSTMAN, disitu kita bisa langsung melempar request atau menghit api dan melihat respons-nya tanpa harus menyiapkan sisi client atau tampilan aplikasi kita terlebih dahulu.
Sekian penjelasan singkat saya mengenai REST API, semoga bermanfaat.
The End.
z— — —i
