すごく簡単！3ステップでAPIモックを実装する方法

APIモックとは、実際のAPIと同様に振る舞う、テスト用の仮想的なAPIのことです。つまり、実際のAPIが提供するデータや機能に対して、APIモックが同じように応答を返すように設計されます。APIモックアップの略語です。

APIモック、もしくはモックアップは、様々な場合で役立ちます。特に開発者がAPIを実際に実装する前に、APIの動作をシミュレートしてテストすることができるため、効率的なアプリケーションの開発を促進します。また、APIモックを使用することで、実際のAPIが利用可能になる前に、アプリケーションのテストを行うことができます。

button

それでは、APIモックが必要となる場合、どうすればいいですか？次は、一番使いやすいAPI管理ツールのApidogを使って、3ステップだけで、APIモックを簡単に実装する方法を皆さんに紹介します。

完璧なモックアップツール - Apidog

Apidogは、非常に強力なAPI管理ツールです。このツールによって、APIの設計、開発とデバッグ、モック、自動化テストなども実現されます。完全なAPIソリューションを提供しているApidogには、Postman、JMeter、Swagger、Mockの機能も全て備えています。

APIモックを行いたい場合、Apidogは必ず役立ちます。内蔵されているMockエンジンは、現実みたいなデータをモックできるようになります。Apidogのモック機能によって、バックエンドのAPI開発が完了するまで待つ必要がなく、すぐAPIモックが返してくれるデータを用いて、開発プロセスを前に進めることができます。

ApidogでAPIモックを簡単に実行する方法

それでは、Apidogを使ってAPIモックを行うには、どうすればいいですか？すごく簡単な３ステップだけでAPIモックを実行できるので、次の詳細ガイドを参照してみましょう。

button

ステップ⒈ プロジェクトの作成

Apidogでのプロジェクトは、複数のAPIを管理するために利用されています。APIは、いずれかのプロジェクトに属しなければなりません。

Apidogを開き、初期画面で「新しいプロジェクト」ボタンをクリックして、プロジェクトを新規に作成できます。

ステップ⒉ APIの新規作成

ここでユーザーの詳細情報を取得するAPIの作成を例にして、APIの新規作成機能を皆さんに紹介します。

リクエスト方法：GET
エンドポイント：api/user/{id}、その中でidがpathパラメータで、ユーザーのIDを表します。
レスポンスの種類：json
レスポンスの内容：

{
  id: number, // ユーザーのid
  name: string, // ユーザー名
  gender: 1 | 2, // 性別：1 
  phone: string, // 携帯番号
  avatar: string, // プロフィール写真のURL
}

新規に作成したプロジェクトの初期ページの「＋」ボタンをクリックして、APIを新規に作成します。

上記の項目をそれぞれのボックスに記入して保存します：

ここでユーザーの詳細情報に関するAPIを作成できました。その同時に、Apidogは記入したフィールドやパラメータに従って、モックデータを自動的に作成します。Mockの下の「Request」をクリックすると、Mockのレスポンスを確認することができます。

それから、Requestの画面で「送信」ボタンをクリックして、レスポンスのデータを取得できます。

button

ステップ⒊モックに利用されるマッチングルールの設定

皆さんも気づいたのでしょうか？nameがstring型と設定しているが、漢字の名前が返されてしまいました。phoneがstring型としているが、携帯番号が返されてしまいました。avatarがstring型と設定しているが、画像のURLが返されてしまいましたね。それはなぜですか？

Apidogには内蔵のモックマッチングルールがあるからです。事前の設定がなければ、Apidogはデフォルトで内蔵のマッチングルールに従って、データを生成できます。これらのマッチングルールが、「プロジェクト設定」→「機能設定」→「Mock設定」で変更できます。

また、APIの変更ページで、特定のフィールドに特定のモックルールを振り分けることもできます。

button

ガイド：Apidogのモックルールの解説

Apidogのモックのマッチングルール

フィールドがあるマッチングルールに一致する場合、モックルールを満たすランダムの内容を返します。

フィールドが全てのマッチングルールに一致していない場合、当該フィールドの種類を満たすランダムの内容を返します。

マッチングルールは3つの種類をサポート

⒈ワイルドカード：*は、0または任意の複数の文字にマッチします。?は、1つの任意の文字をマッチします。例えば、*nameはusername、nameなどにマッチできます。

⒉正規表現

⒊完全なマッチ

Mock.jsにも対応可能

MockルールはMock.jsと完全に互換性があり、Mock.jsにはない文法（例えば携帯電話番号@phone）も修正されています。よく使われるのは:

1.@Integer：整数。@Integer(min, max)

2.@String:文字列。@String( length ):長さの文字列を指定する

3.@Regexp( regexp ):正則

4.@userName：ユーザーの名前

5.@Url：ウェブサイト

実際の開発プロセス中に、より複雑な状況に遭ったことがよくあります。例えば：違うパラメータによって、違うレスポンスの内容を返します。Idが1の場合、正常なユーザー情報を返しますが、Idが2の時、エラーを報告します。Apidogは、このような状況にも対応できます。

まとめ

本文では、Apidogという高機能のAPI管理ツールを使って、APIモックを行う方法を皆さんに紹介しました。もちろん、APIモックの他に、Apidogは、API仕様書生成、APIのデバッグ、APIテストの自動化などの機能にも対応しています。興味やニーズがある方は、Apidogのホームページにアクセスして、もっと詳しく了解しましょう。

button