カスタムAPIのコール
この章の『RAMLドキュメントを使用したAPIの定義とテスト』では、APIデザイナが提供するテスト・ツールを使用して登録したAPIをテストしました。 ここでは、Postman を使用して、OMH の外部から API をコールする手順を確認します。 Postman は、HTTP ヘッダーやリクエスト・パラメータなどを GUI で指定することができ、REST API を簡単にテスト実行できます。
Step-1 モバイル・バックエンド「FIF_Technician_xx(このハンズオンの『モバイル・バックエンドの作成』で作成したモバイル・バックエンド)の「設定」ページを開き、次の値を確認します。
- モバイル・バックエンドID
- 匿名キー(「表示」リンクをクリックして表示させる)
- ベースURL
備考: Webブラウザの画面サイズによっては以下の図とはレイアウト異なることがあります。
図:モバイル・バックエンドの「設定」ページ
Step-2 デスクトップにあるPostmanのアイコンをダブルクリックし、Postmanを起動します。「Enter request URL」とヒントが表示されている入力フィールドに、『RAMLドキュメントを使用したAPIの定義とテスト』で登録したカスタムAPIのFIF_IncidentReport_xxのGET /incidentsリソースのURLを入力します。
<ベースURL>/mobile/custom/FIF_IncidentReport_xx/incidents
図:PostmanでカスタムURLのリソースURLを指定
Step-3 「Headers」タブ・ページを開き、下記の表のように「key」と「value」を指定します。
表:「Headers」タブ・ページに指定する「key」と「value」
key | value |
---|---|
oracle-mobile-backend-id | <モバイル・バックエンドID> |
Authorization | Basic <匿名キー> |
図:Postmanの「Headers」タブ・ページに「key」と「value」を指定
Step-4 「Send」ボタンをクリックすると、レスポンスが表示されます。
図:Postmanにレスポンスが表示された状態
悪意のあるモバイル・アプリからリソースを保護するため、AMCe上にホストされたAPIを実行する場合、たとえ認証が不要だったとしても、モバイル・バックエンドIDと匿名キーをヘッダー情報に指定してリクエストを送信する必要があります。