【API開発】PostmanでAzure Functionsに接続するまで

こんばんは。今日は、Postmanを使ってAzure Functionsに接続する手順について整理しておこうと思います。今後、Postmanを使ってAzure FunctionsのAPIをテスト等するための下準備のステップになります。

それでは早速参ります。

POSTMANとは?

Postmanは、2014年に創業したpostdot technologies,incが開発したAPI開発支援ツールです。アメリカとインドに拠点がある会社のようですね。

Postmanのトップページ

Postmanの概要と使い方についてはこちらの記事に分かりやすく解説されていましたのでご紹介します。Postmanでは、APIのテストに加え、API公開には欠かせないマニュアルの作成なども効率化してくれる優れもののようです。

https://www.webprofessional.jp/master-api-workflow-postman/

それではこのPostmanを使う準備を進めていきます。

POSTMANのインストール

Postmanは、Webで利用することもできますし、クライアントアプリケーションで利用することもできます。今回はクライアントアプリケーションを利用する方法で準備を進めていきます。

クライアントアプリケーションは以下からダウンロード可能です。

https://www.postman.com/product/rest-client/

REST Clientのダウンロードページ

Postmanを利用する際には、Web利用でもアプリ利用でも、アカウントが必要です。アプリをダウンロード・インストール後、起動するとアカウントでのログインが求められますので、未作成の場合は作成しておきます。

Postmanアプリのログイン画面

ログインすると、自分のワークスペースが開きます。

Postmanアプリのトップ画面

細かい設定は後々やるとして、続けて早速Azure Functionsの関数を接続していきたいと思います。

事前準備:Azure Functionsに関数を作成する

っと、ここでもし、接続対象のAzure Functionsが未作成なら、作成しておきます。

手順は以下をご参照ください。

https://docs.microsoft.com/ja-jp/azure/azure-functions/functions-create-function-app-portal

上記手順に従って、HTTPトリガーの関数を1つ作成した状態にしておきます。

POSTMANでAzure Functionsの関数を実行する

上記で準備した関数のURLを控えます。(「関数のURLの取得」より)

このURLには、APIのURLに加えて、キー情報が含まれます。URLだけたたいても関数にはアクセスできず、必ずこのキー情報が必要になります。

ここでPostmanの登場です。Postmanで新規タブを開き、上でコピーしたURLを張り付け、POSTメソッドで実行します。

関数が実行されました!とても簡単ですね・・・!!!

Postmanでは、HTTPリクエストヘッダやパラメータを簡単に設定できるため、必要に応じて設定します。

APIに認証が設定されている場合

Postmanではさまざまな認証方式がサポートされています。

Azure Functionsの場合は、AADやGoogle , Facebookなどの認証プロバイダが提供するアクセストークンをヘッダに含める必要があります。こちらに方法の解説がありますので、参考にしてください。

https://stackoverflow.com/questions/47627995/using-postman-to-perform-azure-ad-auth-for-azure-functions

以上、PostmanをAzure Functionsに接続する方法でした!

実際にAPIに対するテストを構成する方法なども、そのうち整理しておきたいと思います。

おしまい

0

この記事を気に入っていただけたらシェアをお願いします!

ABOUT US

アバター
Yuu113
初めまして。Yuu113と申します。 兵庫県出身、東京でシステムエンジニアをしております。現在は主にデータ分析、機械学習を活用してビジネスモデリングに取り組んでいます。日々学んだことや経験したことを整理していきたいと思い、ブログを始めました。旅行、カメラ、IT技術、江戸文化が大好きですので、これらについても記事にしていきたいと思っています。