RESTful Web Services - การกำหนดแอดเดรส

การกำหนดแอดเดรสหมายถึงการค้นหาทรัพยากรหรือทรัพยากรจำนวนมากที่อยู่บนเซิร์ฟเวอร์ คล้ายกับการระบุที่อยู่ทางไปรษณีย์ของบุคคล

ทรัพยากรแต่ละรายการในสถาปัตยกรรม REST ถูกระบุโดย URI (Uniform Resource Identifier) URI เป็นรูปแบบต่อไปนี้ -

<protocol>://<service-name>/<ResourceType>/<ResourceID>

วัตถุประสงค์ของ URI คือการค้นหาทรัพยากรบนเซิร์ฟเวอร์ที่โฮสต์บริการเว็บ แอตทริบิวต์ที่สำคัญอีกประการหนึ่งของคำขอคือ VERB ซึ่งระบุการดำเนินการที่จะดำเนินการกับทรัพยากร ตัวอย่างเช่นในRESTful Web Services - First Application Chapter URI คือhttp://localhost:8080/UserManagement/rest/UserService/users และ VERB คือ GET

การสร้าง URI มาตรฐาน

ต่อไปนี้เป็นประเด็นสำคัญที่ต้องพิจารณาในขณะออกแบบ URI -

• Use Plural Noun- ใช้คำนามพหูพจน์เพื่อกำหนดทรัพยากร ตัวอย่างเช่นเราใช้ผู้ใช้เพื่อระบุผู้ใช้เป็นทรัพยากร

• Avoid using spaces- ใช้ขีดล่าง (_) หรือยัติภังค์ (-) เมื่อใช้ชื่อทรัพยากรแบบยาว ตัวอย่างเช่นใช้ Authorized_users แทนผู้ใช้ที่ได้รับอนุญาต% 20users

• Use lowercase letters - แม้ว่า URI จะไม่คำนึงถึงตัวพิมพ์เล็กและใหญ่ แต่ก็เป็นแนวทางปฏิบัติที่ดีที่จะให้ url เป็นอักษรตัวพิมพ์เล็กเท่านั้น

• Maintain Backward Compatibility- เนื่องจาก Web Service เป็นบริการสาธารณะ URI ที่เปิดเผยต่อสาธารณะจึงควรพร้อมใช้งานเสมอ ในกรณีที่ URI ได้รับการอัปเดตเปลี่ยนเส้นทาง URI เก่าไปยัง URI ใหม่โดยใช้รหัสสถานะ HTTP 300

• Use HTTP Verb- ใช้ HTTP Verb เสมอเช่น GET, PUT และ DELETE เพื่อดำเนินการกับทรัพยากร การใช้ชื่อการดำเนินการใน URI ไม่ดี

ตัวอย่าง

ต่อไปนี้เป็นตัวอย่างของ URI ที่ไม่ดีในการดึงข้อมูลผู้ใช้

http://localhost:8080/UserManagement/rest/UserService/getUser/1

ต่อไปนี้เป็นตัวอย่างของ URI ที่ดีในการดึงข้อมูลผู้ใช้

http://localhost:8080/UserManagement/rest/UserService/users/1