カスタムプロトコル API

カスタムプロトコル API は、カスタムプロトコルを使用する API を管理するために使用します。

この機能を使用すると、さまざまな種類のプロトコル（Thrift、UDP、Kafka、RabbitMQ、RocketMQ など）の API ドキュメントを統一的に作成・保守でき、すべて Apidog 内で一元管理できます。

HTTP API ドキュメントと同様に、カスタムプロトコル API ドキュメントもフォルダツリー、検索・フィルターオプション、一括管理、オンライン共有に対応しており、チームでの共同作業や外部共有がより簡単になります。

カスタムプロトコル API の作成

フォルダツリーの上部で + アイコンにカーソルを合わせ、New Other Protocol APIs を選択して Other Custom Protocol API をクリックします。

プロトコルタイプを選択します（選択肢には Thrift、Kafka などが含まれます。または Manage Protocol をクリックしてカスタムプロトコルを追加します）。

各プロトコルにはデフォルトテンプレートが用意されています。

次の詳細を入力します。

URI: エンドポイントの一意の ID です。他のエンドポイントと区別するために使用します（HTTP エンドポイントの URL パスに似ています）。

Endpoint Name: エンドポイントの名前です。

Basic Information: ステータス、メンテナー、タグ、その他の詳細です。

Documentation Details: 説明、使用方法、例などをより柔軟に編集できます。

保存後、選択したプロトコルのエンドポイントドキュメントが作成されていることを確認できます。

カスタムプロトコル API ドキュメントもオンライン共有に対応しており、共同作業や外部への提示がより簡単になります。

コラボレーションリンクをコピーして、プロジェクト内で共有できます。

また、Publish Docs > Quick Share に移動し、含めるエンドポイントを選択して、カスタムプロトコル API ドキュメントを共有するかどうかを選択することもできます。