概要¶

API一覧¶

ID	名称	HTTPメソッド	URL
API_USE_0101	ユーザ一覧取得	GET	/api/users
API_USE_0102	ユーザ詳細取得	GET	/api/users/{userId}
API_REC_0101	履歴取得	GET	/api/users/records
API_REC_0102	履歴登録	POST	/api/users/{userId}/records
API_REC_0103	履歴更新	PUT	/api/users/{userId}/records/{recordId}
API_REC_0104	今日の履歴ID取得	GET	/api/users/{userId}/records/today
API_FAV_0101	お気に入り登録	POST	/api/users/{userId}/favorites
API_FAV_0102	お気に入り削除	DELETE	/api/users/{userId}/favorites
API_FAV_0103	お気に入り一覧取得	GET	/api/users/{userId}/favorites
API_FAV_0104	お気に入りの今日の履歴取得	GET	/api/users/{userId}/favorites/records

認証にはAmazon Cognitoを利用する。

認証が必要なAPIはすべて以下のリクエストヘッダーを付与する。

変数名	型	必須	論理名	例	備考
Authorization	string	✅	アクセストークン	Bearer xxxxx	Cognitoから払い出されるアクセストークン。

すべてのAPIのエラーレスポンスは以下のJSONフォーマットで返す。

エラーレスポンスサンプル
{
  "err_code": "E0001",
  "err_message": "something wrong...",
  "detail": {},
}

キー名	型	説明
err_code	string	エラーコード。全API共通と個々のAPIで定めたコードを返す。
err_message	string	エラーメッセージ。簡潔なエラー内容を返す。
detail	Object	エラー詳細。エラー発生状況などの詳細情報を返す。

認証されてない場合や、不正な認証の場合のエラー。

err_code	err_message
E9001	No Authorization header
E9002	Error decoding token headers
E9003	Public key not found in jwks.json
E9004	Signature verification failed
E9005	Token is expired
E9006	Token was not issued for this audience
E9007	Token issuer is invalid
E9008	Token use is invalid
E9009	System user is invalid

サーバー上の処理が一定時間内で完了せずにタイムアウトした場合のエラー。