Sobes.tech
Middle

Ποιους κανόνες ονοματοδοσίας πόρων στο REST γνωρίζετε;

sobes.tech AI

Απάντηση από AI

Σε ένα 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