Apidogの利用を開始する

本文では、Apidogを利用し始めようとするユーザーに対して、コア機能を紹介します。

テストプロジェクトへのアクセス

Apidogを開くと、システムによって自動的に作成された「テストプロジェクト」があります。

当該プロジェクトにアクセスすると、ペットストアに関するAPIがあります。

APIの設計と作成

API 設計者はApidogを使用して、APIを視覚的に作成するか、OpenAPI仕様などのフォーマットからインポートできます。

既存のAPIを参考にして、「＋」ボタンをクリックして、「新しいAPI」からAPIを新しく作成します。

外部のAPIをインポート

Apidog は、Postman、Swagger、ApidocなどのAPI仕様書からインポートできます。

プロジェクトの設定画面で、「データをインポート（手動）」をクリックして、ファイルとURLからAPIをインポートできます。

ファイルからインポート

JSONかYAMLフォーマットのファイルをこのエリアにドラッグ＆ドロップすることでインポートします。

URLからインポート

URLを使用してインポートしたい場合、JSONかYAMLフォーマットのファイルのURLを利用する必要があります。Swagger UIのURLを直接に利用できません。

仕様書をオンラインで生成

Apidogは、APIの設定に基づいて、APIの仕様書を自動的に生成できます。API仕様書は、他のメンバーがより効率的にAPIを利用するために効果を果たします。どれかのメンバーがApidogでAPIの仕様を変更する場合、API仕様書もそれに伴って変更されるので、バージョンコントロールも非常に簡単です。

Mock機能を利用

Mock機能は、Apidogのコア機能の1つになります。Mock機能を利用すると、開発者はAPI早期の設計段階でもレスポンスのデータを生成できるようになります。APIの単体テスト（デバッグ）段階でも、Mock機能を利用して仮想のデータを生成できます。

Requestの送信

Apidogは、強力のAPI管理ツールだけではなく、APIのRequestを送信できます。ターミナルやコマンドプロンプトで複雑なコマンドラインを使用せずに、直感的なUIでRequestを送信してレスポンスを取得できます。

入力ボックスで、完全のAPIエンドポイントのURLを入力すると、Apidog は、URL中のパスパラメータなどを識別し、下のパラメータ欄に表示されます。そして、必要に応じて必須のパラメータを記入して、Requestを「送信」できます。

返すレスポンスのデータに異常がない場合、今後便利に利用するために、このRequestをAPIとして保存することもできます。