Insomnia入門：で環境変数を使用する方法

Insomniaは、APIの設計、デバッグ、自動テスト、負荷テストを行うための非常に強力なツールです。

Insomniaは、開発、プロダクション、サンドボックス、モックサーバーなど、さまざまな目的で利用できる環境の概念をサポートしています。この記事では、Insomniaで環境変数を活用する方法について詳しく説明します。具体的には、OpenAPIドキュメントからインポートした値を含む「OpenAPI環境」の設定方法を例示します。

コレクションの作成方法

Insomnia入門：コレクションの作成方法

Insomniaは、APIの設計、デバッグ、自動テスト、負荷テストを行うための強力なツールです。この記事では、OpenAPIドキュメントを使用してInsomniaでコレクションを作成する手順について説明します。このコレクションには、APIの動作方法を示すためのリクエストとレスポンスの例が含まれます。 ステップ1: プロジェクトの準備 Insomniaを開くと、まず空のプロジェクトが表示されます。ここに私たちのAPIについての情報を追加していく必要があります。次のステップでは、Insomniaコレクションを作成し、このプロジェクト内に保存します。 ステップ2: OpenAPIドキュメントのインポート OpenAPIドキュメントをコレクションに変換することで、既に定義されているOpenAPI操作のリクエストとレスポンスを手動で作成する手間を省くことができます。幸いなことに、InsomniaはOpenAPIをサポートしています。 方法1: Git経由でのインポート Paid「Team」アカウントをお持ちの方は、Insomniaを通じてリポジトリをGitクローンすることができ

echoapiブログDaniel Anderson

ステップ1: 環境の選択

Insomniaを開くと、デフォルトでは「Base Environment」という環境が選択されています。これを「OpenAPI env」に変更するためには、ドロップダウンメニューをクリックして「OpenAPI env」を選択します。これにより、インポートされたOpenAPIドキュメントから事前に設定されたさまざまな値が利用可能になります。

ステップ2: 環境変数の設定

OpenAPIドキュメントのインポート時に、何らかのエラーが発生する場合があります。たとえば、Train Travel APIをインポートした際に、環境変数が正しく設定されずエラーが表示されるケースがあります。

URLに表示されるエラーは以下の通りです：
「attempted to output null or undefined value」

このエラーは、_.host変数を選択することで修正できます。

方法としては、各操作に対してこの設定を行う必要がありますが、これは理想的とは言えません。この問題についてはInsomniaのチームも認識しており、近い将来に修正されることが期待されています。

ステップ3: 環境変数の活用

環境変数を正しく設定すれば、Insomnia内でのAPIテストが非常に効率的になります。環境ごとに異なる設定を簡単に切り替えることができるため、開発から本番環境への移行もスムーズに行えます。

EchoAPI: 優れた代替案

最後に、Insomniaの代替としてEchoAPIを紹介します。EchoAPIは超軽量なコラボレーションツールで、API開発を支援します。特徴として、API設計、デバッグ、自動テスト、および負荷テストが含まれ、Scratch Pad機能をサポートします。また、IntelliJ IDEA、VS Code、およびChromeのリクエストキャプチャ拡張プラグインが提供されており、ログイン不要で手軽に利用できます。これにより、開発者はPostmanの代わりにEchoAPIを検討する価値があるでしょう。

次回のAPI開発の際には、EchoAPIをぜひ試してみてください。きっと満足いただけるはずです。