REST Canvas

Concevoir des API en utilisant les principes RESTful, en définissant des ressources, des verbes et des exemples de requêtes et de réponses.

Résultats

• Conception cohérente de l’API RESTful

Comment cela fonctionne-t-il ?

SVG | PNG | JSON

Étapes

1. Identifier les ressources clés exposées par l’API
2. Définir la structure du modèle de ressources de l’API
3. Spécifier les verbes HTTP utilisés pour interagir avec les ressources
4. Fournir des exemples de demandes et de réponses pour chaque verbe

Astuce

• Utiliser les méthodes HTTP standard (GET, POST, PUT, DELETE)
• Veiller à ce que les URI des ressources soient intuitifs et cohérents
• gestion des erreurs de documents et codes de réponse