J'ai lu un article sur Internet qui dit d'éviter les points de fin de repos nommer avec des actions que nous essayons de traiter, plutôt que de mentionner les actions utilisées dans le pluriel de l'entité que nous traitons pour un exemple si nous sommes Utilisation avec les utilisateurs, nommez les points finaux tels que API / utilisateurs, cela est donc vraiment correct pour un scénario ayant moins de points d'extrémité, ce qui signifie avoir toujours des types de requêtes HTTP toujours différents. Pour un exemple si nous considérons l'API Il n'y a qu'un seul type de @get Mappage, d'autres types également identiques dans un scénario d'avoir plusieurs points de fin avec la même méthode de requête HTTP Quelle est la meilleure façon de nommer ces points de fin?
3 Réponses :
Les seules conventions de dénomination qui sont généralement suivies dans la nommage des API consiste à éviter les verbes.
par exemple. Si vous souhaitez upsert (insertion / mise à jour), un utilisateur, post / API / utilisateur sera bon. Obtenir un utilisateur -> Obtenir / API / utilisateur / {id} Obtenir tous les utilisateurs -> Obtenir / API / Utilisateurs
Si vous avez des exigences spécifiques, vous pouvez également mentionner ici.
Il y a très subtil différent entre ce qui est des services réparateurs et quels sont les webservices. Du Documents officiels de printemps:
Pour obtenir quelle saveur de repos, utilisez le printemps haïssez un projet de printemps visant à vous aider à écrire des sorties hypermédia. Cette bibliothèque / dépendance minuscule nous donnera les constructions pour définir un service reposant, puis le rendre dans un format acceptable pour la consommation de clients. Vous pouvez plus lire sur le printemps haïssant ici
Un ingrédient critique à tout service reposant est d'ajouter des liens vers des opérations pertinentes.
Maintenant, sur votre question, les points de fin de repos que nous obtenons comme une fonctionnalité dans le repos de données de printemps et sont la conformité haïquée (pour les opérations de CRUD):
Obtenez la cartographie à l'adresse http: // localhost: 8080 / utilisateurs / Pour répertorier toutes les entités.
Obtenez la mappage à http: // localhost: 8080 / utilisateurs / Post Mappage à http: // localhost: 8080 / utilisateurs / avec le corps de JSON / XML pour créer un
Nouvelle entité.
Mettez mappage sur http: // localhost: 8080 / utilisateurs / Supprimer mappage à http: // localhost: 8080 / utilisateurs / Comme vous l'avez observé en voyant simplement l'URL, personne ne peut deviner quelles actions vont prendre,
Tout dépend du type de méthode HTTP.
Si vous voulez en savoir plus sur le repos et le haïssez (qui fournissent beaucoup plus de fonctionnalités
que CRUD tels que la pagiantion, le tri, etc.)
Voir cette documentation de printemps officielle sur haïssant et Services reposants
Vous devriez vérifier cet article sur Richardson Maturity Modèle: https://martinfowler.com/articles/RichardsonMaturingModel .html
Il contient toutes les informations pour créer une API reposante bien conçue