URI sumber sepatutnya dibaca seperti path berasaskan kata nama kepada sesuatu benda, bukan tindakan. HTTP method sudah membekalkan kata kerja, jadi URI hanya perlu mengenal pasti sumber dengan jelas dan konsisten.
URI sumber sepatutnya dibaca seperti path berasaskan kata nama kepada sesuatu benda, bukan tindakan. HTTP method sudah membekalkan kata kerja, jadi URI hanya perlu mengenal pasti sumber dengan jelas dan konsisten.
GET /users/42 — bukan GET /getUser?id=42. Method (GET) ialah kata kerja./users ialah koleksi; /users/42 ialah satu ahli. Kekal jamak di mana-mana menjadikannya boleh diramal./users/42/orders = "order milik user 42".kebab-case, huruf kecil. /blog-posts, bukan /blogPosts atau /Blog_Posts./users?role=admin&sort=-created_at./users koleksi user
/users/42 seorang user
/users/42/orders order milik user 42 (sub-collection)
/users/42/orders/1001 order tertentu milik user itu
/orders/1001 order yang sama, juga boleh dicapai di aras atas
GET /users/42/orders?status=shipped&sort=-created_at&page=2 HTTP/1.1
Accept: application/json
Elakkan bersarang dalam melebihi satu atau dua aras — /users/42/orders/1001/items/5/reviews menjadi rapuh. Setelah order mempunyai ID sendiri, utamakan /orders/1001. Untuk tindakan yang tidak muat dengan CRUD (cth. "hantar emel"), sub-resource gaya controller boleh diterima: POST /users/42/verify-email.
Penamaan yang konsisten ialah apa yang menjadikan API terasa intuitif — pembangun yang telah melihat /users dan /users/42 boleh meneka dengan betul /products dan /products/99 tanpa membaca dokumentasi. Penemu duga menggunakan ini untuk mengukur sama ada anda berfikir dalam sumber (minda REST) berbanding panggilan RPC (/doThisThing). Anti-pattern paling lazim — kata kerja dalam path, penjamakan yang tidak konsisten, dan URL bersarang dalam — semuanya menjadikan API lebih sukar dipelajari dan diselenggara, dan ia menandakan pembangun yang belum menghayati kekangan uniform-interface REST. Reka bentuk URI yang baik juga mengekalkan pengasingan kebimbangan: identiti dalam path, penapisan dan paginasi dalam query string, yang mengekalkan caching dan routing bersih.
Pustaka soalan temu duga IT dengan jawapan terperinci — daripada Junior hingga Senior.
Derma