1

以下が可能かどうか知りたいです。

Swagger は、メッセージ ベースの API を文書化するために必要なもののほとんどです。たとえば、コマンド メッセージの場合、「Post」ではなく「Command」と言いたいのですが、「path」の代わりにコマンドの名前を付けたいと思います。

仕様には、「x-」プロパティを使用してベンダー拡張が可能であると記載されていますが、1) これを行う方法の例が見つからず、2) これらのプロパティの使用が私の目標を達成するのに役立つかどうかわかりません.

先に進むのに役立つリソースを教えてくれる人はいますか?

4

1 に答える 1

3

Swagger は、 HTTP 動詞に基づくREST API を文書化するように設計されています。動詞を置き換えたり、新しい動詞を発明したりすることはできません。

ベンダー拡張機能は、仕様で許可されていない追加情報を追加できるようにするためにありますが、最終的には、REST API を対象としています。

私が集めたものからすると、あなたは何か違うことを説明しようとしています.

Swagger の追加の道 (つまり、REST 以外の API をカバーする) の提案を歓迎します。そのためには、swagger-spec リポジトリで問題を開くことをお勧めします。

于 2015-05-15T05:33:39.987 に答える