-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy path16c-restapi3.js
executable file
·23 lines (19 loc) · 1.32 KB
/
16c-restapi3.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// --- URL Design ---
// url,path atau endpoint adlah salah satu bagian terpenting ketika membangun REST API
// dengan merancang endpoint yang baik, penggunaan API akan lebih mudah dipahami
// dalam merancang endpoint, perlu mengikuti aturan umum/ convention agar penggunaan API memiliki standar yang dmengerti banyak developer
// gunakan kata benda daripada kata kerja pada endpoint path
// maksudnya adalah titik akhir path. contoh :
// /getArticles atau /addArticles
// cukup berikan endpoint GET /articles untuk mendapatkan data artikel atau POST /articles utk menambahkan artikel
//gunakan kata jamak pada endpoint utk resource collection
//ini dikarenakan jarang ada data yg memiliki 1 item
// dengan jamak, diharapkan kita konsisten dg isi database
// gunakan endpoint berantai utk resource yg memiliki hirarki atau relasi
//contoh utk mendapatkan daftar komentar pada sebuah artikel, endpoint GET /articles/:id/comments
//tidak hanya GET, prinsip ini juga cocok diterapkan pada HTTP verb POST, PUT ataupun DELETE
// referensi :
// https://www.paessler.com/it-explained/server
// https://www.ibm.com/support/knowledgecenter/SSGMCP_5.3.0/com.ibm.cics.ts.internet.doc/topics/dfhtl21.html
// https://www.ibm.com/support/knowledgecenter/SSGMCP_5.3.0/com.ibm.cics.ts.internet.doc/topics/dfhtl22.html
// https://everything.curl.dev/project/name