Insomniaは、API設計、デバッグ、自動テスト、負荷テストを行うための強力なツールです。
Insomniaは、開発、プロダクション、サンドボックス、モックサーバーなど、さまざまな目的で利用できる環境の概念をサポートしています。この記事では、Insomniaで環境変数を活用する方法について詳しく説明します。具体的には、OpenAPIドキュメントからインポートした値を含む「OpenAPI環境」の設定方法を例示します。
ステップ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をぜひ試してみてください。きっと満足いただけるはずでしょう。