API basée sur des messages Documenter dans Swagger ou RAML

Question

Comment nous documentons un message API basée à Swagger ou RAML? Par message, je veux dire que le point de terminaison est toujours le même, mais on peut envoyer plusieurs types de message à ce point de terminaison et selon le type de message d'entrée, nous obtenons des réponses différentes. Existe-t-il un exemple de ce type d'API que je peux avoir?

Merci. Luis Oscar

Answer 1

Swagger et de la SV est particulièrement utilisé pour documenter les API comme REST. Après une longue recherche, j'ai trouvé la spécification AsyncAPI. Cela peut être utilisé pour documenter vos API pilotées par message.

aussi un Theres __gVirt_NP_NN_NNPS<__ éditeur en ligne disponible et si vous êtes déjà familier avec l'utilisation fanfaronnades, YAML il est facile de commencer avec cette spécification