Correct ReST URI design

Question

J'ai le scénario (hypothétique) suivant:

Demande de rapport sur les étudiants dans les classes dans les écoles. J'ai 3 tables école, classe, étudiant. La classe a un FK school_id et l'étudiant a un FK class_id.

J'ai mes entités toutes configurées et prêtes à l'emploi et je suis sur le point de les exposer via une interface de repos.

Si mes URIs ressembler à ceci: Écoles - Liste des écoles
écoles/{id} - école spécifique
écoles/{id}/cours - liste des classes
écoles/{id}/classes/{id} - classe spécifique
écoles/{id}/classes/{id}/étudiant - étudiants liste
écoles/{id}/classes/{id}/étudiant/{id} - étudiants spécifiques

Même si dans le cas d'un étudiant spécifique, je vais ignorer le je vais ignorer l'id de l'école et l'ID de la classe comme tout ce qui m'importe pour Ma requête est l'identifiant de l'étudiant.

Dois-je avoir: Écoles/étudiant/{id} - pour des étudiants spécifiques.

Answer 1

Il n'y a aucun problème avec l'exposition d'une ressource à partir de plusieurs emplacements (bien que ce soit une bonne idée de spécifier le canonical url s'il y a plusieurs emplacements *).

Ainsi, il peut être judicieux de fournir toutes les URIs suivantes:

lists: 

student 
classes/{id}/student 
schools/{id}/classes/{id}/student 

specific: 

student/{id} 
classes/{id}/student/{id} 
schools/{id}/classes/{id}/student/{id} 

Dans votre cas, la relation entre les entités ne sont pas une entité elle-même. Si tel était le cas (par exemple, si l'étudiant de la classe de ressources possédait un attribut spécifiant depuis combien de temps l'étudiant était dans la classe), les identificateurs URI contenant les identifiants class et student deviennent plus importants car ils fournissent un bon emplacement pour exposer les attributs de la relation elle-même. * Pour fournir au mieux l'URL canonique au client, vous pouvez l'envoyer comme valeur du "Content-Location" dans les en-têtes de réponse.

Answer 2

En outre, il est utile d'avoir une convention pour utiliser des noms pluriels/singuliers. Certaines personnes aiment seulement les noms singuliers, certains (comme les gens de Ruby) utilisant les deux et un outil de conversion. Par exemple, dans la réponse de Ian student, l'URL de la liste doit être students.