APIが期待どおりに応答していることを検証するために、手軽で簡単なAPI呼び出しをしたいのであれば、ここが最適です。必要なのがAPIのクイックチェックだけであれば、APIテストツールは非効率的になる可能性があります。また、コードを書くことが誰にとっても得意なわけではないため、Swagger Inspector を使用してAPIをテストすることが、あらゆるレベルのテスターにとって最良の選択肢となります。
Swagger Inspector を使えば、誰でもエンドポイントを呼び出して結果を確認できるため、API テストが非常に簡単になります。これはテストに優れているだけでなく、統合を検討している新しい API を探索したり、そこからどのような情報が得られるかを知りたい場合にも便利です。無料で利用でき、必ずしもログインは必要ありません！
このチュートリアルでは、Swagger Inspector を使用して基本的な API 呼び出しを行う方法について説明します。
この例では、スター・ウォーズ API を使用します。主に、最近「フォースの覚醒」を観たからですが（この件についてはたくさんの意見がありますが、残念ながらこのブログは「フォースの覚醒」に関する考察記事ではありません。この件について意見がある場合は、ツイートしてください）、その内容がさまざまな人々に簡単に理解できるAPIであるという理由もあります。
ぜひ一緒に試して、例を自分の選んだエンドポイントに変更してみてください。
ステップ1 – サインイン
Inspector を開いて サインインまたはサインアップしてください。すでに SwaggerHub アカウントをお持ちの場合は、その資格情報でサインインできます。サインアップすると、呼び出し履歴を 保存 できるだけでなく、準備ができたら OpenAPI 定義を生成できます。
ステップ2 - Chrome 拡張機能をダウンロードする。
Swagger Inspector を初めて使用し、ファイアウォールの背後にある API を検査しようとしている場合は、Swagger Inspector Chrome 拡張機能をダウンロードする必要があります。サイトを離れる必要は
ありません。Safari を使用している場合は、Safari の開発者オプションで「クロスオリジン制限を無効にする」を有効にしてください。これは、多くの API にアクセスするために必要となります。
スター・ウォーズ API は拡張機能のダウンロードを必要としませんが、他の API をテストしたい場合は、拡張機能がテストの成功に不可欠です。
ステップ3 – 呼び出しを行う
エンドポイントをページの最上部にあるバーに貼り付け、「送信」を押します。
この例では、https://swapi.co/api/people/13 リソースの GET メソッドを呼び出しています。このリソースがどのような情報を返すかについてヒントを挙げます...
素晴らしい！すべての正しい情報が提供されているようです。
これで、基本的なAPIテストが正式に完了しました。 Swagger Inspectorを使えば本当にこれほど簡単です。セットアップ時間も、デスクトップダウンロードも、待機時間もありません。
ご自身のAPIエンドポイントで試すか、Swagger Inspectorの動作を理解するためにスター・ウォーズAPIを使い続けてみてください。 他のエンドポイントもいくつか試して様々なリクエストを蓄積し、コレクションを1つか2つ作成してから、OpenAPI定義を生成してみてください！
Swagger InspectorがAPIの成功にどのように役立つかについての詳細は、Swagger Inspectorページをご覧ください。今日からAPIのテストを始めましょう！
また、より自分のペースで学習できるように、ビデオデモも作成しました。ビデオの下にトランスクリプトがあります。
トランスクリプト：
皆さん、こんにちは。シャノンです。今日はSwagger Inspectorについて少しお話します。
これはSwaggerファミリーの最新ツールであり、私たちが本当に興奮している製品です！
特に、API定義を作成できる機能は素晴らしいです。人々が何度も利用し続けるのは、APIコールを何度も行い、それらを分類できる機能だと確信しています。
APIとやり取りする際に必要なUIで、やりたいことをすべて実行できます。
このツールでできることの1つは、APIエンドポイントのテストです。私の今お気に入りのAPIはスター・ウォーズAPIです。とても素晴らしいAPIで、スター・ウォーズの世界に関連する惑星を取得できます。
スター・ウォーズのAPIを呼び出すと、タトゥイーンが惑星の1番目であることがわかります。
Swagger Inspectorを使用すると、APIコールを迅速かつ簡単に行うことができ、APIコールをピン留めすることもできます。
APIコールを選択して「よし、これはお気に入りだからこのAPIコールを続けるぞ」と言うことができます。
気が変わったら、リクエストのピン留めを解除するだけで、これらのリクエストをコレクションに追加して呼び出しを分類できます。
もう一つできることは、API定義を作成することです。API呼び出しの履歴でチェックを入れるか、直接コレクションに移動してコレクション内のすべての呼び出しを選択できます。
コレクション内の特定の呼び出しを選択して、API定義を作成します。
それを行うと、この定義が自動生成されるので、複数のAPI呼び出しがある場合は、それらすべてを選択できます。
バックエンドでは、APIに関連するパスや、Swagger Inspectorの使用中に使用したすべてのクエリパラメータを確実に理解するために、リファクタリングを行っています。
最後に、API作成の段階では名前を求められ、それらのAPI呼び出しに基づいて判明したすべての情報を含むAPI定義を作成します。
SwaggerHubに入ったら、そこでAPIを拡張します。
ここにタイトルを追加するなど、特定の情報を追加してください。これにより、APIとこれらすべての変更が保存されます。
SwaggerHubでAPIを保存し、他の素晴らしい操作を行うことができます。
Swagger Inspectorについては、今日はこれくらいです。
Swagger Inspectorは無料であり、そのままであり続ける予定です！