Structure de repos extrémités

Question

Supposant Je exigences:

• Inscription par e-mail
• Registre par réseau social
• Connexion par email
• Connexion par le réseau social
• Déconnexion
• Obtenez mon profil
• Modifier mon profil
• obtenir un certain profil de l'utilisateur
• Liste mes amis
• Liste des amis de l'utilisateur
• Inviter des amis du réseau social
• Ajouter produit
• Modifier produit
• Recherche produit
• Liste mes produits
• Liste des produits utilisateur

Quelle devrait être la structure de l'API REST des points de terminaison?

Answer 1

Demandez-vous toujours:

Quelles sont mes ressources?

• Inscription par email POST /api/registration
• enregistrer par le réseau social POST /api/providerRegistration
• Obtenez un certain profil de l'utilisateur GET /api/user?userId={userId}
• Liste mes amis GET /api/friends
• Liste des amis de l'utilisateur GET /api/friends?userId={userId}
• Ajouter produit POST /api/product
• Modifier ce produit PUT/PATCH /api/product/{productId}
• Recherche Produits GET /api/products?status={status}
• Liste mes produits GET /api/products?userId={userId}

Et ainsi de suite - vous obtenez l'essentiel de celui-ci. Notez que le chemin (ressource REST) ​​est un nom (product), pas un verbe (search).