რა წესები გაქვს რესურსების სახელების დასაწერად REST-ში?

RESTful API-ში რესურსები სახელწოდებებით სახელდება, რომლებიც წარმოადგენს კოლექციებს ან ობიექტების ნიმუშებს.

სახელწოდების წესები:

• მრავლობითი რიცხვი გამოიყენეთ კოლექციებისთვის: GET /products, POST /users.
• კონკრეტული რესურსის მისაწვდომად გამოიყენეთ იდენტიფიკატორი: GET /products/123, PUT /users/john_doe.
• შენახული რესურსები ჰიერჰიარულად სახელდება: GET /users/john_doe/orders, DELETE /products/456/reviews/789.
• განათავსეთ URL-ებში მოქმედებები ზმნებით: GET /getAllProducts ნაცვლად გამოიყენეთ GET /products. HTTP მეთოდები (GET, POST, PUT, DELETE) უკვე მიუთითებს მოქმედებაზე.
• მცირე ასოები გამოიყენეთ: GET /users უკეთესია, ვიდრე GET /Users.
• სიტყვები ჰიფენით გამოიყვანეთ: GET /product-categories უკეთესია, ვიდრე GET /productCategories.
• ფაილის გაფართოებები არ გამოიყენოთ: GET /users/john_doe უკეთესია, ვიდრე GET /users/john_doe.json. მონაცემთა ტიპი განსაზღვრულია Content-Type და Accept თავიანთი მეშვეობით.
• საკითხის პარამეტრები გამოიყენეთ ფილტრაციის, სორტირების და გვერდის განლაგებისთვის: GET /products?category=electronics&sort=price&limit=10&offset=0.

მაგალითი:

// ყველა შეკვეთის სია მიიღეთ მომხმარებლის ID 1-ისთვის
// GET /users/1/orders

// ახალი პროდუქტის შექმნა
// POST /products

// პროდუქტის დეტალები მიიღეთ ID 42-ისთვის
// GET /products/42

// მიმოხილვის განახლება ID 10-ისთვის, პროდუქტის ID 5-ისთვის
// PUT /products/5/reviews/10