SwaggerまたはRAMLでメッセージベースのAPIを文書化する

SwaggerまたはRAMLでメッセージベースのAPIを文書化するにはどうすればよいですか？メッセージベースでは、エンドポイントは常に同じですが、複数のメッセージタイプをこのエンドポイントに送信でき、入力メッセージのタイプによって異なる応答が得られます。見ることができるこのタイプのAPIの例はありますか？SwaggerまたはRAMLでメッセージベースのAPIを文書化する

ありがとうございます。 Luis Oscar

出典

2017-04-20 Luis Trigueiros

OpenAPIを/威張っは、RPCスタイルのAPIをサポートしていませんを始めるのは簡単です。対応する提案は[＃664]（https://github.com/OAI/OpenAPI-Specification/issues/664）と[＃801]（https://github.com/OAI/OpenAPI-Specification/issues/801）です。）。 – Helen

SwaggerとOASは、特にRESTのようなAPIを文書化するために使用されます。長い検索の後、私はAsyncAPIの仕様を見つけました。これは、メッセージ駆動APIを文書化するために使用できます。

もThere's利用可能なオンラインエディタ、あなたはすでに闊歩、YAMLを使用して精通している場合、この仕様

出典

2018-02-06 08:11:45 Jehof

ありがとう、非常に知りたい、:-) –

SwaggerまたはRAMLでメッセージベースのAPIを文書化する

答えて

関連する問題