# 習慣 API リファレンス

TaskWorks API の習慣管理関連エンドポイントの詳細ドキュメントです。すべてのエンドポイントはユーザー固有のデータのみを返します（RLS保護）。

## 認証方式

### ApiKey 認証（推奨）
```
Authorization: ApiKey <token>
```
- 設定 > APIキー管理 から生成
- トークンは一度しか表示されないため安全に保管
- ほとんどのエンドポイントで使用可能

### Bearer トークン認証
```
Authorization: Bearer <token>
```
- サービス間通信で使用
- 一部のエンドポイントで必須（例: /api/v1/blocks/windows）

### Cookie 認証
- 標準のセッションベース認証
- Webクライアントで使用
- Cookie専用エンドポイントで必須

## 共通レスポンス形式

すべての成功レスポンスは以下の構造に従います：
```json
{
  "data": <response_data>,
  "error": null
}
```

すべてのエラーレスポンスは以下の構造に従います：
```json
{
  "error": "<error_type>",
  "message": "<human_readable_message>",
  "code": "<optional_error_code>",
  "context": <optional_additional_context>
}
```

## HTTP ステータスコード

- 200: 成功
- 201: 作成完了
- 400: 不正なリクエスト（検証エラー）
- 401: 未認証（認証が必要）
- 403: 禁止（権限なし）
- 404: 未検出
- 409: 衝突（リソースの競合）
- 500: サーバー内部エラー

## ページネーション

一部のエンドポイントはカーソルベースのページネーションをサポート：
- cursor: 次ページの開始位置
- limit: 返す項目数（1-100、デフォルトはエンドポイントにより異なる）

レスポンス形式：
```json
{
  "data": {
    "items": [...],
    "nextCursor": "string | null",
    "hasMore": boolean
  },
  "error": null
}
```

## API エンドポイント

### 習慣（Habits）

#### GET /api/v1/habits/dashboard

習慣ダッシュボード用の集計データを取得します。

**認証:** ApiKey / Bearer / Cookie

**クエリパラメータ:**
- year: number（オプション、2020-2030、デフォルト: 現在の年）
- month: number（オプション、1-12、デフォルト: 現在の月）

**レスポンス スキーマ:**
```json
{
  "data": {
    "summary": {
      "year": number,
      "month": number,
      "days": Array<{ "date": string, "done": boolean }>
    },
    "dayStats": Record<string, {
      "required": number,
      "completedTasks": number,
      "done": boolean
    }>,
    "completionRate": number,
    "totals": {
      "trackedDays": number,
      "doneDays": number,
      "remainingDays": number
    },
    "today": {
      "required": number,
      "completed": number,
      "percentage": number
    },
    "streak": {
      "current": number,
      "longest": number,
      "breakDate": "string | null"
    },
    "timezone": "string",
    "taskCount": number,
    "isCurrentMonth": boolean
  },
  "error": null
}
```

**エラーケース:**
- 400: 無効な年（2020-2030）または月（1-12）
- 401: 認証が必要です