Kokias resursų pavadinimo taisykles žinai REST?

RESTful API resursai vadinami daiktavardžiais, kurie atstovauja kolekcijas arba objektų pavyzdžius.

Vardų suteikimo taisyklės:

• Naudokite daugiskaitą kolekcijoms: GET /products, POST /users.
• Prieigos prie konkretaus ištekliaus metu naudokite identifikatorių: GET /products/123, PUT /users/john_doe.
• Įdėti ištekliai vadinami hierarchiškai: GET /users/john_doe/orders, DELETE /products/456/reviews/789.
• Venkite veiksmažodžių URL: vietoj GET /getAllProducts, naudokite GET /products. HTTP metodai (GET, POST, PUT, DELETE) jau nurodo veiksmą.
• Naudokite mažąsias raides: GET /users yra pageidautina, o ne GET /Users.
• Žodžius atskirkite brūkšniais: GET /product-categories yra pageidautina, o ne GET /productCategories.
• Nenaudokite failų plėtinių: GET /users/john_doe yra pageidautina, o ne GET /users/john_doe.json. Duomenų tipas nustatomas pagal Content-Type ir Accept antraštes.
• Naudokite užklausos parametrus filtravimui, rūšiavimui ir puslapiavimui: GET /products?category=electronics&sort=price&limit=10&offset=0.

Pavyzdys:

// Gauti visų užsakymų sąrašą naudotojui su ID 1
// GET /users/1/orders

// Sukurti naują produktą
// POST /products

// Gauti produkto detales su ID 42
// GET /products/42

// Atnaujinti atsiliepimą su ID 10, skirtą produktui su ID 5
// PUT /products/5/reviews/10