0
0

API

Last updated at Posted at 2024-08-27

リクエストヘッダーとリスポンスヘッダー

APIエンドポイントとは?

APIのURI部分のことをAPIエンドポイントと言います。

APIリクエストURLとは?

getなどのメソッド名の横に表示されているURLでリクエストURLとパラメータ部分に分けられる。例えば下の例だと
スクリーンショット 2024-08-16 19.02.51.png

{{base_url}}/openapi/v1/dailyreport/maintenancemodel

までがリクエストURLでそれ以降がパラメータ部分となる。getメソッドで条件を絞りたい場合はパラメータを追加すれば良い。また階層構造の場合は以下のように「.」で繋いであげればいい。

writeMaintenanceModel.saveModel.workDetail.endDistance=50000

そしてAPIのAPIパスはすべて相対パスである。相対パスの基準URL(例:http://localhost/)

パスパラメータとクエリパラメータの違い

パスパラメータ

https://qiita/params1/params2

クエリパラメータ

https://qiita/params1/params2?eigyousyoCode=00000001

見た目の違いとしては「params2」の後に「?〜」が」あるかどうか

一意なリソースを表す場合はパスパラメータ。
クエリパラメータは省略可能な付加情報のことで、検索・フィルタなどプラスアルファの条件を付け足したい時に用いる

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0