Quelles sont les meilleures pratiques pour la page racine d'une API REST?
https://stackoverflow.com/questions/2894723
-
04-10-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianQuestion
Je voudrais savoir s'il y a des meilleures pratiques sur le point de terminaison racine pour un service Web REST? Je veux dire, devrait-il être une courte documentation sur l'utilisation de l'API lui-même? Faut-il être un document XML décrivant toutes les méthodes disponibles? Faut-il revenir seulement « méthode inconnue »?
La solution
Cette question posée est claire. Je suppose que cela veut dire quelque chose comme un répertoire que toutes les méthodes de l'API sont sous. Par exemple, le répertoire racine de l'API Flickr serait http://api.flickr.com/services / repos / .
Pour un exemple d'un projet qui accède à l'API Flickr, voir python-flickrapi
Autres conseils
La question est tout à fait clair pour moi.
Je pense qu'il doit répondre à 404. S'il n'y a aucune ressource associée au chemin racine, alors il n'y a rien à retour.
Si vous sentez que 404 n'est pas utile, il serait également OK pour retourner l'URL de la documentation.
1. NerdDinner utilise WCF Data Services, qui est un excellent moyen de mettre en œuvre correctement les services RESTful. La raison pour laquelle je suis le point que, et non des services de données WCF est directement parce qu'il est un site Web public et vous pouvez l'utiliser. 2. MediaWiki est pas un bon exemple parce qu'ils passent des actions dans l'URI, mais il est techniquement un service RESTful et spectacle est beaucoup d'idées intéressantes.
le point rootend de l'API REST est l'API définie pour la première barre oblique i.e. « / » de l'URL après le répartiteur-servlet. Il contient toutes les GET pour la liste des ressources (la plupart du temps l'obtenir pour toutes les tables de base de données) cette liste contient encore tous les éléments et un seul article, il y aura SUPPRIMER, PUT / PATCH et URL SELF get. Rendant ainsi la mise en œuvre de HATEOS.
REST est censé être auto décris afin d'avoir la racine montre une erreur est une mauvaise conception, à mon avis. J'aime la racine contient des informations qui vous permet de naviguer dans le reste de l'API. Ainsi, par exemple la racine peut contenir un lien vers une liste des catégories de produits à partir de laquelle l'utilisateur peut sélectionner API une catégorie, puis une liste de produits, etc. Un auto décrivant des moyens d'API moins de documentation pour écrire et tenir à jour !!
