Apidogプロジェクトでは、モジュールを活用してAPIを体系的に整理できる。モジュールは技術アーキテクチャにおける「サービス」と似た概念で、特にマイクロサービスベースのシステムにおいて、APIの管理や可視化を効率化するために設計されている。各モジュールは、それぞれ関連するAPI、コンポーネント(スキーマ、レスポンス、Security Schemeなど)、および環境ごとのBase URLを個別に持つ。また、各モジュールは独立したSwagger/OpenAPI仕様ファイルに対応している。モジュールを活用することで、以下のようなケースでAPIをより適切に整理できる。密接に関連するサービス
例:AIプロジェクトの場合、テキスト生成API用のモジュール、画像生成API用のモジュール、音声API用のモジュールなどに分けて管理できる。
マイクロサービス
例:ECプロジェクトでは、認証、注文、商品管理などのサービスごとにモジュールを分割できる。
複数のAPIバージョン
例:外部向けにLegacy、LTS、Latestなど、異なるAPIバージョンを公開している場合、それぞれをモジュールとして管理できる。
モジュールの作成#
1
プロジェクト画面で、フォルダツリー上部にカーソルを合わせ、「+」ボタンをクリック。ドロップダウンメニューから「New Module」を選択する。
2
モジュール名を入力し、「Save」をクリック。新しいモジュールがフォルダツリーに追加される。モジュールをクリックすると、以下の詳細情報を確認できる。
モジュール変数(環境変数に似ているが、このモジュール内のAPIリクエストのみで利用可能) モジュールごとのBase URL設定#
モジュールを作成すると、自動的に環境管理ページに反映される。新規追加したモジュールごとに、各環境のBase URLを個別に設定できる。リクエスト時に正しいBase URLを利用する#
デフォルトでは、各モジュールのAPIリクエストは、そのモジュールの現在の環境で設定されたBase URLとAPIパスを自動的に組み合わせて送信される。他のモジュールのBase URLを使ってリクエストを送ることはできない。1つのモジュール内で複数のサービス(Base URL)を扱う場合、フォルダ単位やAPI単位で利用するBase URLを手動で指定することも可能。ただし、この運用方法はApidogの旧来の使い方であり、バージョン2.7.16以降は推奨されていない。代わりに、サービスごとにモジュールを分割し、それぞれ独自のBase URLを設定することを推奨する。 Modified at 2025-11-05 10:38:08