API ドキュメント

以下は、スレッドおよびレスポンスを管理するためのAPIドキュメントです。各エンドポイントの説明は以下の通りです。

GET /api

APIのベースURLは以下の通りです：

利用可能なエンドポイント

1. スレッド一覧の取得（get_threads）

スレッドの一覧を取得します。ページングにも対応しています。

レスポンス例

{
    "status": "success",
    "data": {
        "threads": [
            {
                "id": 1,
                "title": "スレッドタイトル1",
                "created_at": "2024-12-01T12:34:56",
                "last_response_time": "2024-12-02T13:40:00"
            },
            {
                "id": 2,
                "title": "スレッドタイトル2",
                "created_at": "2024-12-01T12:35:00",
                "last_response_time": "2024-12-01T14:20:30"
            }
        ],
        "pagination": {
            "current_page": 1,
            "total_pages": 5
        }
    },
    "error": null
}
    

2. スレッド詳細の取得（get_thread）

指定したスレッドの詳細情報およびそのスレッドに対するレスポンス一覧を取得します。ページングにも対応しています。

レスポンス例

{
    "status": "success",
    "data": {
        "thread": {
            "id": 1,
            "title": "スレッドタイトル1",
            "created_at": "2024-12-01T12:34:56"
        },
        "responses": [
            {
                "id": 1,
                "user_id": 123,
                "content": "レスポンス内容1",
                "created_at": "2024-12-01T13:45:00"
            },
            {
                "id": 2,
                "user_id": 124,
                "content": "レスポンス内容2",
                "created_at": "2024-12-01T14:15:00"
            }
        ],
        "pagination": {
            "current_page": 1,
            "total_pages": 3
        }
    },
    "error": null
}
    

エラーレスポンス

エラーが発生した場合、以下のようなレスポンスが返されます。

{
    "status": "error",
    "data": null,
    "error": "エラーメッセージ"
}
    

エラーコード例

• 400 Bad Request: リクエストに必要なパラメータが不足している場合。
• 404 Not Found: 指定されたリソースが存在しない場合。
• 500 Internal Server Error: サーバー内で予期しないエラーが発生した場合。

その他の注意事項

- APIレスポンスは常にJSON形式で返されます。

- ページングを使用してデータを取得する際は、limitとpageパラメータを指定することが推奨されます。