Le Guide API ReST | Marmicode
👨🏻‍🍳 Marmicode.fr👨🏻‍💻 Consulting & Code Review✉️ Help!
Rechercher…
Le Guide API ReST par Marmicode
API ReST
Conventions & Bonnes Pratiques
Nommage
Base URL
Media Type
Versioning
Propriété “id”
Polymorphisme
Datetime
Ressource d'Association
Pourquoi Appliquer ces Bonnes Pratiques
Zalando ReSTful API Guidelines
Les Outils
Sécurité des APIs ReST
Autres Spécifications
Quelques Liens & Ressources
Stay Tuned
📝Blog
🐦Twitter
📬Newsletter
Propulsé par GitBook
Media Type
Le Media Type habituel défini avec le header Content-Type est application/json.
Il est courant de définir un Media Type spécifique pour une API ou éventuellement en fonction du standard utilisé. Exemple : application/vnd.github+json.
Les Media Type de type application/vnd* ne sont pas standards et peuvent éventuellement poser des problèmes avec certaines librairies ou connecteurs (Ex.: Web Application Firewall).
Certains s’amusent à retourner un contenu HTML (présentation, documentation, démo etc…) lorsque le client ne présente pas le bon Media Type dans le header Accept.
C’est élégant…
…mais pas pratique du tout ! Qui n’a jamais testé une URL d’API ReST sur son browser ?
Nous verrons plus tard que pour des raisons sécurité, il est recommandé de rejeter les requêtes ne présentant pas le bon header Content-Type.
Précédent
Base URL
Suivant
Versioning
Dernière mise à jour 3yr ago
Copier le lien