カスタムプロトコルAPI

カスタムプロトコルAPIは、独自プロトコルを用いたAPIの管理を目的とした機能です。

この機能を利用することで、Thrift、UDP、Kafka、RabbitMQ、RocketMQなど、さまざまなプロトコルタイプのAPIドキュメントを統一的に作成・管理できます。すべてのAPIはApidog上で一元的に管理されます。

HTTP APIドキュメントと同様に、カスタムプロトコルAPIドキュメントもフォルダツリーによる整理、検索・フィルタ機能、一括管理、オンライン共有などに対応しており、チーム内外でのコラボレーションや情報共有を円滑に行うことができます。

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

フォルダツリー上部の「＋」アイコンにカーソルを合わせ、「新しい他の種類のAPI」を選択し、「カスタムプロトコルAPI」をクリックします。

プロトコルタイプを選択します（ThriftやKafkaなどの選択肢があり、「プロトコルの設定」をクリックして独自プロトコルを追加することも可能です）。

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

以下の項目を入力します。

URI：APIの一意なIDです。他のAPIと区別するために使用されます（HTTP APIのURLパスに相当）。

エンドポイント名：APIの名称を入力します。

基本情報：ステータス、管理者、タグなどの情報を設定します。

ドキュメント詳細：説明、利用方法、サンプルなどを柔軟に編集できます。

保存後、選択したプロトコルのAPIドキュメントが作成されます。

カスタムプロトコルAPIドキュメントもオンライン共有に対応しており、チーム内での協働や外部への公開が容易です。

プロジェクト内で共有用リンクをコピーして、関係者と共有できます。

また、「ドキュメント公開」→「クイック共有」から、共有するAPIを選択し、カスタムプロトコルAPIドキュメントを含めるかどうかを設定できます。