En aquest tema, explorarem els conceptes de recursos i URIs (Uniform Resource Identifiers) en el context del disseny d'APIs RESTful. Els recursos són elements clau en les APIs RESTful, ja que representen les entitats amb les quals interactuen els clients. Les URIs són les adreces que identifiquen de manera única aquests recursos.

Un recurs és qualsevol informació que pot ser nomenada i representada en una API. Això pot incloure:

• Documents (per exemple, un document PDF)
• Imatges (per exemple, una foto de perfil)
• Serveis (per exemple, un servei de traducció)
• Col·leccions d'altres recursos (per exemple, una llista d'usuaris)

• Usuari: Representa un usuari en un sistema.
• Producte: Representa un producte en una botiga en línia.
• Comanda: Representa una comanda realitzada per un usuari.

Una URI (Uniform Resource Identifier) és una cadena de caràcters que identifica de manera única un recurs. En el context de les APIs RESTful, les URIs són utilitzades per accedir als recursos.

Una URI típica té l'estructura següent:

• http://: El protocol utilitzat.
• example.com: El domini del servidor.
• /resource: El camí que identifica el tipus de recurs.
• /{id}: Un identificador únic per al recurs específic.

• http://api.example.com/users/123: URI per accedir a l'usuari amb ID 123.
• http://api.example.com/products/456: URI per accedir al producte amb ID 456.
• http://api.example.com/orders/789: URI per accedir a la comanda amb ID 789.

El disseny de les URIs és crucial per a la usabilitat i la claredat de l'API. A continuació, es presenten alguns principis i bones pràctiques per dissenyar URIs efectives:

1. Nomenclatura Consistent: Utilitza noms de recursos coherents i significatius.

   • Correcte: /users, /products
   • Incorrecte: /u, /prd

2. Utilitza Plurals per a Col·leccions: Utilitza noms en plural per representar col·leccions de recursos.

   • Correcte: /users, /products
   • Incorrecte: /user, /product

3. Evita Verbs en les URIs: Les URIs haurien de representar recursos, no accions.

   • Correcte: /users/123
   • Incorrecte: /getUser/123

4. Utilitza Subrecursos per a Relacions Jeràrquiques: Representa relacions jeràrquiques utilitzant subrecursos.

   • Correcte: /users/123/orders
   • Incorrecte: /orders?userId=123

• Obtenir tots els usuaris: GET /users
• Obtenir un usuari específic: GET /users/{id}
• Crear un nou usuari: POST /users
• Actualitzar un usuari existent: PUT /users/{id}
• Eliminar un usuari: DELETE /users/{id}

Dissenya les URIs per a una API que gestiona una biblioteca amb llibres i autors.

1. Obtenir tots els llibres.
2. Obtenir un llibre específic.
3. Crear un nou llibre.
4. Actualitzar un llibre existent.
5. Eliminar un llibre.
6. Obtenir tots els autors.
7. Obtenir un autor específic.
8. Obtenir tots els llibres d'un autor específic.

Solucions

1. GET /books
2. GET /books/{id}
3. POST /books
4. PUT /books/{id}
5. DELETE /books/{id}
6. GET /authors
7. GET /authors/{id}
8. GET /authors/{id}/books

Revisa les següents URIs i identifica els errors de disseny segons els principis esmentats:

1. /getAllUsers
2. /user/123
3. /authors/123/getBooks
4. /createBook

Solucions

1. Error: Utilitza un verb (getAllUsers). Correcte: GET /users
2. Error: Utilitza singular (user). Correcte: GET /users/123
3. Error: Utilitza un verb (getBooks). Correcte: GET /authors/123/books
4. Error: Utilitza un verb (createBook). Correcte: POST /books

En aquesta secció, hem après sobre els recursos i les URIs en el context de les APIs RESTful. Els recursos representen les entitats amb les quals interactuen els clients, i les URIs són les adreces que identifiquen de manera única aquests recursos. Hem revisat els principis de disseny de URIs i hem practicat amb exercicis per reforçar els conceptes apresos. En el següent tema, explorarem els mètodes HTTP i com s'utilitzen per interactuar amb els recursos.