หลักการทั่วไปสำหรับการออกแบบ URI ที่ดี:
- อย่าใช้พารามิเตอร์การค้นหาเพื่อเปลี่ยนสถานะ
- อย่าใช้พาธผสมกัน ตัวพิมพ์เล็กจะดีที่สุด
- อย่าใช้ส่วนขยายเฉพาะการใช้งานใน URI ของคุณ (. …
- อย่าให้ส่วนเส้นทางสั้น
- ใช้พารามิเตอร์การค้นหาสำหรับการเลือกย่อยของทรัพยากร เช่น การแบ่งหน้า คำค้นหา
อะไรทำให้การออกแบบ URI ดี
URI ควรเป็นไปตาม โครงสร้างแบบลำดับชั้นที่คาดเดาได้เพื่อเพิ่มความเข้าใจ และด้วยเหตุนี้ ความสามารถในการใช้งาน: สามารถคาดเดาได้ในแง่ที่ว่ามันสอดคล้องกัน มีลำดับชั้นในแง่ที่ว่าข้อมูลมีโครงสร้าง -ความสัมพันธ์RESTful APIs ถูกเขียนขึ้นสำหรับผู้บริโภค … ออกแบบสำหรับลูกค้าของคุณ ไม่ใช่สำหรับข้อมูลของคุณ
การออกแบบ URI คืออะไร
URI. Uniform Resource Identifier (URI) คือ ชุดอักขระที่ไม่ซ้ำซึ่งระบุทรัพยากรเชิงตรรกะหรือทางกายภาพที่ใช้โดยเทคโนโลยีเว็บ URI อาจถูกใช้เพื่อระบุสิ่งใดๆ รวมถึงวัตถุในโลกแห่งความเป็นจริง เช่น ผู้คน สถานที่ แนวคิด หรือแหล่งข้อมูล เช่น หน้าเว็บและหนังสือ
ควรปฏิบัติตามกฎข้อใดต่อไปนี้เพื่อออกแบบ URL ที่ดี
เลือกหนึ่งตัวเลือกขึ้นไป URI ไม่ควรเปลี่ยนแปลง URI จะต้องสร้างโดย URI ของลูกค้า ควรมีความยาว URI สั้น ควรเลือกใช้คำกริยา HTTP แบบตรงตามตัวพิมพ์เล็กและตัวพิมพ์ใหญ่แทน ของชื่อการดำเนินการใน URI ต้องใช้ช่องว่างเมื่อออกแบบ URI Redirection
ไม่ควรเปลี่ยน URI หรือไม่
URI ก็ควรเป็นแบบถาวรเช่นกัน (เช่น เลือก URI หนึ่งครั้งแล้วปล่อยไว้อย่างนั้น)… จะมีเวลาที่คุณต้องการปรับปรุงตัวเลือกของคุณหรือต้องเปลี่ยนโครงสร้าง URI เมื่อสิ่งนี้กลายเป็นสิ่งจำเป็น อย่าลืมตั้งค่า HTTP 301 ย้ายการเปลี่ยนเส้นทางอย่างถาวรบนเซิร์ฟเวอร์ของคุณ