はじめに
Web APIの設計・開発、テストをサポートするツールとして有名なPostman
何となくGETで値を受け取ったり、POSTしてDBに値を保存したり、、、といった基本的な使い方はわかっているがある時
「あれ??連想配列ってどうやって送るんだ???」
と詰まったので、ここに記録します
またLaravel + Open APIという開発環境の例で進めます
どうやって配列をPOST送信するか
画像とともに手順を以下に記載していきます!
まずはRequest内のBodyセクションを開きましょう
今まではパラメーターで送ってばかりでParamsしか開いたことがありませんでした・・・
👇こっちではありません!!
raw + JSONの設定にする
恐らくデフォルトでこの設定になってるとは思いますが、一応確認しましょう
必要な配列を入れる
仮に以下のようなOpen API定義がyml
であったとします。
requestBody:
description: "申請"
required: true
content:
application/json:
schema:
type: object
properties:
start_date_time: { $ref: "../../../../components/schemas/reports.yml#/start_date_time" }
end_date_time: { $ref: "../../../../components/schemas/reports.yml#/end_date_time" }
break_times:
type: array
items:
type: object
properties:
start_date_time: { $ref: "../../../../components/schemas/break_times.yml#/start_date_time" }
end_date_time: { $ref: "../../../../components/schemas/break_times.yml#/end_date_time" }
required:
- start_date_time
- end_date_time
required:
- start_date_time
- end_date_time
これをPostmanでPOST送信する場合、Request内のBodyは以下のようになります。
{
"start_date_time": "2024-01-20 10:00:00",
"end_date_time": "2024-01-20 18:00:00",
"break_times": [
{
"start_date_time": "2024-01-20 12:00:00",
"end_date_time": "2024-01-20 13:00:00"
},
{
"start_date_time": "2024-01-20 15:00:00",
"end_date_time": "2024-01-20 16:00:00"
}
]
}
これでOK!!!
Postman初心者だったので配列を送るだけも躓きました