API HTTP & messages¶

API HTTP¶

L’API HTTP publique de l’application Zéphir est une vue partielle des messages transitant sur le routeur de messages. Elle utilise le format JSON.

L’URI de votre message devrait commencer par l’espace de nom du domaine fonctionnel de votre microservice (exemple: calc.add).
Privilégiez l’utilisation de paramètres nommés pour l’API de votre message.
Limitez les données transmises avec le message. Si possible utilisez des références plutôt que de passer l’entité.
Préferez le patron de conception “event” plutôt que le “rpc”.
Pensez à décrire votre message dans le répertoire common/messages/<version> et à passer l’attribut public à true si vous souhaitez voir votre message exposé sur l’API HTTP par le microservice api-bridge

Tous les messages envoyés sur le bus de l’application Zéphir par le service api-bridge sont automatiquement préfixés par la version.

Exemple: Pour le message décrit dans services/common/messages/v1/example.calc.add.yml, l’URI du message sur le bus sera v1.example.calc.add.

Le service api-bridge ajoute également certains paramètres nommés aux messages qui transitent par lui:

_request_id String

Identifiant de la requête HTTP à l’origine du message. Pour la traçabilité des opérations, il est recommandé de transférer cet identifiant sur les messages qui pourraient être émis en cascade et d’afficher celui ci dans les journaux d’erreur et d’information.