FitExerciseDB APIのレスポンス項目を解説

一覧の中でも単独でも、すべての種目に同じ16項目があります。必須の5項目は、その動きが何で、どの筋肉に効くかを表します。残りはトレーニングとカロリーの詳細です。

bodyPart、target、equipmentの正確な文字列は分類用エンドポイントから取得します。詳しくはAPIドキュメントをご覧ください。

保証されているのはid、name、bodyPart、target、equipmentだけです。残りの11項目は任意かつnull許容としてモデル化し、空の値が画面上で何を意味するかを項目ごとに決めてください。APIに合ったTypeScriptの型は次のとおりです。

type Exercise = {
  id: string;                 // "0001", keep it a string
  name: string;
  bodyPart: string;
  target: string;
  equipment: string;
  category?: string | null;
  difficulty?: string | null;
  mechanic?: string | null;
  force?: string | null;
  met?: number | null;
  caloriesPerMinute?: number | null;
  averageCaloriesPerMinute?: number | null;
  averageCaloriesPerHour?: number | null;
  secondaryMuscles?: string[] | null;
  instructions?: string[] | null;
  language?: "en" | "fr" | "es" | "pt" | "zh" | "ja";
};

現在のデータでは、1324件すべての種目で16項目すべてに値がありますが、スキーマ上はnullが許されるため、これに頼らないでください。

2つのルールでほとんどのバグを防げます。1つ目は、instructionsがnullのときは空のリストを描画せず、手順のセクションを隠すこと。2つ目は、カロリーのエンドポイントを呼ぶ前にmetを確認することです。MET値のない種目は数値ではなく422エラーを返します。

caloriesPerMinuteは標準的な体重で保存された値で、一覧での簡易表示用です。averageCaloriesPerMinuteは分かりやすい名前で同じ値を繰り返したもので、averageCaloriesPerHourはその値を60倍して丸めたものです（1分4.3kcalは1時間258kcalになります）。どれもユーザーが誰かは考慮していません。

個人向けの推定には、体重と時間をGET /v1/exercises/{id}/calories?bodyweightKg=80&minutes=30に渡します。種目のMETに体重と時間を掛けて計算します。計算式と注意点はMETカロリーガイドにあります。MET値はCompendium of Physical Activitiesに基づくため、どの結果も推定値です。

一覧と検索は同じ包み方です。dataに配列、paginationにpage、pageSize、totalが入ります。既定のページサイズは50、最大は100なので、1,324種目を最大サイズで取得すると14回のリクエストになります。ドキュメントの一部の例にはtotalPagesも載っていますが、どちらの場合でも動くよう自分で計算してください。

{
  "data": [ { "id": "0001", "name": "3/4 Sit-up", "bodyPart": "Waist", "target": "Abs", "equipment": "Body Weight" } ],
  "pagination": { "page": 1, "pageSize": 50, "total": 1324 }
}

const pages = Math.ceil(total / pageSize); // 1324 / 100 = 14

単一種目のGET /v1/exercises/{id}は同じ16項目に加えて、HAL形式の_linksオブジェクトを返します。caloriesのリンクはテンプレート形式なので、クライアントは2つのクエリパラメータを埋めるだけでURLを手で組み立てる必要がありません。一覧には_linksは含まれません。

"_links": {
  "self": { "href": "/v1/exercises/0001" },
  "related": { "href": "/v1/exercises/0001/related" },
  "calories": { "href": "/v1/exercises/0001/calories{?bodyweightKg,minutes}", "templated": true },
  "marketplacePreview": { "href": "/marketplace/preview/0001.gif" }
}

?lang=fr（またはes、pt、zh、ja）を付けると、name、bodyPart、target、equipment、secondaryMuscles、instructionsが翻訳され、languageには指定したコードが入ります。id、数値項目、そしてcategory、difficulty、mechanic、forceの4つのラベルは変わりません。そのため、数値は一度だけキャッシュし、言語ごとにテキストだけを取り直せます。

言語の決まり方と、検索語を英語のままにする理由は検索と言語のガイドで解説しています。試すにはエクササイズデータベースを見るか、ドキュメントをご覧ください。 レスポンスに画像フィールドはありません：ExerciseDB GIFの購入と埋め込みと種目APIのGIFと動画対応を参照してください。