2013-01-16 3 views
0

J'ai un serveur de repos basé sur Java, et mes clients utiliseront principalement Ruby.Quelle est la meilleure pratique pour les urls reposantes?

Quelle est la meilleure pratique pour la structure d'URL?

Ceci est uniquement pour JSON.

Dites ceci est une application de blog:

par exemple:

Obtenir tous les messages:

GET http://www.example.com/api/v1/posts.json 

Supprimer le post avec id 1:

DELETE http://www.example.com/api/v1/posts/1.json 

Qu'en est-il des collections embarquées comme :

Obtenez tous les commentaires pour le post 1:

GET http://www.example.com/api/v1/posts/1/comments.json 

Voir l'article 1 de commentaire avec id 1:

GET http://www.example.com/api/v1/posts/1/comments/1.json 

Y at-il un document qui va sur cela quelque part? Quelque chose de "officiel"?

+0

Non, il n'y a pas de spécification officielle "RESTful URL design". –

+0

Vous pouvez utiliser Google! –

+0

Avez-vous vérifié http://guides.rubyonrails.org/routing.html#nested-resources –

Répondre

0

Apigee a un livre électronique gratuit sur la conception de l'API RESTful. Vous devez fournir une adresse e-mail pour l'obtenir:

http://offers.apigee.com/api-design-ebook-rr/

Vous allez trouver cela est une question d'opinion, sans spécification officielle, mais vos URL me semblent bonnes, et serait conformément aux lignes directrices de ce livre. L'exception possible étant la dernière. Si 1 est l'identifiant unique d'un commentaire,/posts/1/peut ne pas être nécessaire.

Questions connexes