Les opérations exposées par vos API doivent être pensées pour offrir simplicité, cohérence et efficacité.

Nous vous donnons ici les bonnes pratiques pour structurer et documenter vos opérations afin de rendre vos API plus faciles à consommer et à maintenir.

- Règles OPE -

OPE‑01 : Chaque ensemble d’API DOIT implémenter un health check, ou sonde de vivacité.

OPE‑02 : Le point de terminaison pour le health check DEVRAIT suivre un des noms conventionnels.

OPE‑03 : Chaque ensemble d’API DEVRAIT implémenter une sonde de préparation.

OPE‑04 : La sonde de préparation DEVRAIT suivre un nom conventionnel.

OPE‑05 : Les réponses des sondes DEVRAIENT suivre un format standard.

OPE‑06 : Les sondes PEUVENT offrir différents niveaux de détails.

OPE‑07 : Les réponses détaillées des sondes DEVRAIENT suivre un standard.

OPE‑08 : Les réponses des sondes, même détaillées, NE DOIVENT PAS divulguer de détails techniques.

OPE‑09 : Les sondes DEVRAIENT être proposées avec identification plutôt qu’authentification.

OPE‑10 : Le point de terminaison des sondes DEVRAIT être limité par un mécanisme de quota.