APIをテストする時に、POSTというメソッドは非常に汎用されているHTTPメソッドになります。POSTリクエストを通じて、APIエンドポイントにデータを書き込んだりすることができるかどうかをテストすることができます。本文では、Postmanというよく使われるAPIテスト用のツールを使って、POSTリクエストを簡単に送信する方法を皆さんに紹介します。
また、Apidogは無料のAPIクライアントとして、API呼び出し、コレクション実行やAPIシナリオテストを何の制限もなく完全無料で利用できます。APIに関する作業なら、ぜひ下記のボタンからApidogをご活用ください。👇👇👇
POSTとは
POSTは、HTTPメソッドの一種として、主に指定のサーバーにリソースを追加するように使われています。POSTメソッドを使えば、サーバーでリソースを登録したり、更新したりするなど、書き込み操作がある処理を行うことができます。例えば、以下の操作をPOSTメソッドによって実現されます：
- SNSなどのプラットフォームに投稿
- 新しいユーザー登録
- その他のデータ書き込み操作...
以上の説明から、APIの利用中にPOSTというメソッドを使用する必要がある場合は非常に多くあることが分かりますね。
shimizu chioka
PostmanでPOSTリクエストを送信する
Postmanは、ユーザーがAPIを利用したり、テストしたりする時に、よく使われるツールになります。それでは、PostmanでAPIエンドポイントにPOSTリクエストを送信するには、どうしたらいいですか？次は、非常に詳細なガイドを紹介します。
⒈HTTP MethodをPOSTに設定
APIの通信方式を設定します。PostmanでPOSTリクエストを送信するには、もちろんまずHTTPメソッドをPOSTにする必要がありますね。
⒉エンドポイントURLの設定
HTTPメソッドをPOSTに設定した上、その後ろにAPIエンドポイントとなるURLを記入します。
⒊Postman POST Headerの設定
ここでHeadersタブでヘッダー名とヘッダー値を設定する必要があります。
PostmanでHeaderの設定の例：
- Content-Type: リクエストボディのデータ形式を指定する。(例: application/json)
- Authorization: APIキー等の認証情報を指定する。(例: Bearer xxxxxxxx)
- User-Agent: クライアントの情報を送信する。(例: PostmanRuntime/7.1.1)
- Accept: レスポンスの受け入れ可能なデータ形式を指定する。(例: application/json)
Headerはリクエストごとに異なるので、APIの仕様に合わせて適切に設定する必要がある。認証に必要なヘッダーや、期待するデータ形式をサーバーに通知するヘッダーを送信することで、意図した通りのレスポンスを取得できる。
⒋Postman POST Bodyの設定
リクエストのBodyはAPIの使用に合わせて、適切な形式と内容を指定する必要があります。PostmanでPOSTリクエストのBodyを設定する主な方法は次のとおり：
- raw: 生のテキストやJSON、XMLなどをそのままリクエストボディに設定できる。
- form-data: フォームのようにキーとバリューを設定できる。ファイルのアップロードも可能。
- x-www-form-urlencoded: キーとエンコードしたバリューを&でつなげた形式のデータ。
- binary: バイナリデータの送信に使用する。
- GraphQL: GraphQLのクエリを設定できる。
この中で、rawやform-dataを使用することが比較的に多いでしょう。
Postman POST Bodyの設定例
- JSONデータを送信する場合はrawにJSONを記入する。
- サーバーにファイルをアップロードする場合は、form-dataにkeyとファイルを指定する。
- APIキーや検索条件などを送信する場合は、x-www-form-urlencodedにパラメータを設定する。
⒌PostmanでPOST Requestの送信
画面の右上にある「Send」ボタンをクリックして、JSONデータを送信します。
ここでPostmanでPOSTリクエストの設定を終え、リクエストを送信することができます。
より簡単な方法でAPIリクエストをPOSTできるApidog
Postmanは世界中でよく利用されるツールなのですが、日本語に非対応なので、国内のユーザーはそのツールを効率的に利用できない可能性があります。そこで、日本語対応のApidogというAPI管理ツールを皆さんに紹介します。ApidogはPostmanより機能が強く、制限が少ないツールとして、APIの設計、仕様書生成、APIのテスト、モックなどのAPIライフサイクル管理の機能をも備えています。Postmanのようなコレクションを作成して、APIテストの自動化もサポートされています。
もちろん、ApidogはPOSTリクエストを送信することができます。POSTリクエストのパラメータ、Body、Headerの設定は、Apidogで全部利用することができますし、より直感的なUIでより良いUXを得ることができるのでしょう。
