¿La representación JSON de los recursos REST debe usar URI para los recursos relacionados?

Question

¿Es una buena práctica usar URI en representación JSON (o XML) de recursos REST, por ejemplo

Por ejemplo, para un recurso que tiene una lista de archivos adjuntos, donde cada archivo adjunto tiene una identificación que se puede utilizar para recuperarlo utilizando una URL como http://myserver.com/resources/attachments/:

{ 
    fileName: "screenshot.png" 
    contentType: "application/octet-stream" 
    id: 52004 
} 

¿Debo también añadir un elemento URI como

{ 
    fileName: "screenshot.png" 
    contentType: "application/octet-stream" 
    id: 52004 
    uri: /resources/attachments/52004 
} 

Answer 1

Sí, creo que debería incluir un enlace a cada elemento de la colección. Una API no es RESTful (y, lo que es más importante, no es tan útil) sin los enlaces. Si cree que un cliente humano preferiría tener un enlace que instrucciones sobre cómo solicitar un elemento por ID, lo mismo se aplica a un cliente no humano. También debe dar al cliente una idea de cómo el artículo se relaciona con el recurso actual, proporcionando una relación de enlace:

link : { uri: "/resources/attachments/52004", rel: "/rels/file-attachment" } 

John

Answer 2

Si sería bastante inútil, ya que a pesar de ello necesitará enviar la información de los s erver si el usuario solicitó el recurso y obtendría el recurso de su id en lugar de su URI.

Además, a veces algunos recursos no requieren un URI porque nunca se solicitarán o no se pueden solicitar directamente.