APIでのパラメーターの場所の違い

Question

swaggerを使ってAPIのドキュメントを作りたいです

in: "path"とは何かわからず調べてみたら
query,header,path,formDataとはどういう意味なんでしょうか？

Answer 1

Swaggerについて全く知らずに回答しますが…。
おそらくそのパラメータをどこで受け取るか(どこに含めて送る必要があるか)ということではないでしょうか。
クエリ文字列なのか、リクエストヘッダーなのか、パスなのか、フォームデータとしてなのか…

Comments

[cuku]

例えばGETで情報を取得したいときはGETで返ってくるレスポンスのパラメーターをどこで受け取るかということでしょうか？

[Takumiboo]

例えばスクリーンショットにあるようにpetIDの情報を返すAPIの場合、クライアントからAPIに対して、情報を調べたいペットのpetIDを指定するわけですが、そのpetIDをAPIに対してどのように渡すのか、ということです。

[cuku]

なるほど。わかりました。
フォームデータとはクライアントからAPIに対してたくさんの情報を渡したいときに使用するのでしょうか？

[Takumiboo]

HTMLのformで送るときなどに使うのではないでしょうか。