RESTful Web Services - Định địa chỉ

Định địa chỉ đề cập đến việc định vị một tài nguyên hoặc nhiều tài nguyên nằm trên máy chủ. Tương tự như vậy để xác định địa chỉ bưu điện của một người.

Mỗi tài nguyên trong kiến ​​trúc REST được xác định bằng URI (Định danh tài nguyên đồng nhất) của nó. URI có định dạng sau:

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

Mục đích của URI là định vị (các) tài nguyên trên máy chủ lưu trữ dịch vụ web. Một thuộc tính quan trọng khác của yêu cầu là ĐỘNG TỪ xác định thao tác sẽ được thực hiện trên tài nguyên. Ví dụ, trong chương RESTful Web Services - First Application , URI làhttp://localhost:8080/UserManagement/rest/UserService/users và ĐỘNG TỪ là GET.

Xây dựng một URI chuẩn

Sau đây là những điểm quan trọng cần được xem xét khi thiết kế URI:

  • Use Plural Noun- Sử dụng danh từ số nhiều để xác định nguồn lực. Ví dụ: chúng tôi đã sử dụng người dùng để xác định người dùng như một tài nguyên.

  • Avoid using spaces- Sử dụng dấu gạch dưới (_) hoặc dấu gạch ngang (-) khi sử dụng tên tài nguyên dài. Ví dụ: sử dụng Authorised thay vì% 20users được ủy quyền.

  • Use lowercase letters - Mặc dù URI không phân biệt chữ hoa chữ thường, nhưng một phương pháp hay là chỉ giữ url ở dạng chữ thường.

  • Maintain Backward Compatibility- Vì Dịch vụ Web là một dịch vụ công cộng, một URI sau khi được công khai sẽ luôn có sẵn. Trong trường hợp, URI được cập nhật, hãy chuyển hướng URI cũ hơn sang URI mới bằng cách sử dụng mã Trạng thái HTTP, 300.

  • Use HTTP Verb- Luôn sử dụng HTTP Verb như GET, PUT và DELETE để thực hiện các thao tác trên tài nguyên. Sẽ không tốt khi sử dụng tên hoạt động trong URI.

Thí dụ

Sau đây là một ví dụ về một URI kém để tìm nạp người dùng.

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

Sau đây là một ví dụ về một URI tốt để tìm nạp người dùng.

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