Comment dois-je construire un bon site web API

Question

Je vais construire une API pour une application web et je suis intéressé par ce que les gens peuvent donner à penser que les bonnes pratiques.

J'ai déjà prévu de faire de version (version 1 ne peuvent contrôler certains aspects du système, la version 2 peuvent contrôler plus, mais cela peut nécessiter un changement dans la façon dont l'authentification est effectuée qui serait incompatible avec la version 1), et l'authentification sera distincte de la norme nom d'utilisateur/mot de passe que les gens utilisent pour se connecter (si quelqu'un le fait d'utiliser un outil malveillant de ne pas l'ouvrir à plein de l'emprunt d'identité, juste ce que l'api permet).

Quelqu'un a d'autres idées, ou des exemples de sites avec de très bonnes Api que vous avez utilisés?

Answer 1

Lire la Les Services Web RESTful le livre, qui vous donnent un bon aperçu de la façon dont le REPOS dans la pratique, et d'obtenir jusqu'à la vitesse assez rapidement pour commencer maintenant, avec une certaine confiance.C'est plus utile que de simplement regarder une API existante, car il traite également de la conception des choix et des compromis.

Answer 2

1) faire Cuire le numéro de version directement dans l'URL plutôt que de le laisser passer comme paramètre, depuis que vous donne une totale liberté de modifier l'organisation de votre API espace de noms avec chaque version de bosse.

2) Gardez votre URL de règles de réécriture (le cas échéant) comme simple/légère que possible (mais pas plus), tout en rendant vos URLs aussi belle que possible (mais pas plus).

3) Toujours chercher le meilleur code d'état HTTP, vous pouvez trouver pour chaque réponse (et n'oubliez pas de 202 et 207, par exemple).

4) mettre en Œuvre fasciste paramètre logique de validation et d'information des messages d'erreur.

5) Utilisez-têtes de requête HTTP le cas échéant, au lieu de paramètres (comme les Accepter, par exemple, pour permettre aux clients de spécifier le format de données de la réponse).

6) Organiser votre "noms" de telle manière que les Url utilisées par des clients différents publics sont séparés à proximité de la "racine" de votre arborescence de l'URL (ce qui rend plus facile d'appliquer les différents mécanismes d'authentification pour ces différents publics si nécessaire, ou même carte que les différentes parties de votre URL de l'arbre à différents serveurs).

7) Si vous vous servez régulièrement des pages web sur le même domaine que votre Api et d'utiliser les mêmes informations d'authentification, d'exiger d'une X-requested-with-tête dans vos requêtes à l'API de manière à éviter XSRF vulnerabiities.

Answer 3

Je voudrais prendre un coup d'oeil à prouvé Api:

1. API YouTube
2. L'API Twitter

Il y a beaucoup d'argument au sujet de la question de savoir si ces Api sont "bonnes", mais je pense que leur succès est démontré, et ils sont tous faciles à utiliser.

Answer 4

Utilisation RESTE.

Les services web RESTful architecture est facile à mettre en œuvre et exploite les points forts et sémantique de HTTP pour quoi ils étaient destinés.C'est axée sur les ressources, tout comme le web lui-même.

Amazon Web Services, Google et bien d'autres encore offrent des Api REST pour interagir avec leurs produits.

Answer 5

Le REPOS.

Lire sur les normes pour les Api, ou de copier les idées de l'un des plus populaires.

Être prudent lors de l'authentification des utilisateurs.

Début très très simple.

Construire un site qui utilise les API (même si c'est pas utile) pour vérifier les choses fonctionnent.Peut-être vous pouvez créer une version mobile du site ou quelque chose qui vous oblige à utiliser l'API dans beaucoup de profondeur.