関連テンプレ構成
テンプレート
# IF-001: ユーザー情報取得API
**概要:**
認証基盤からユーザーの基本情報(ID、氏名、メールアドレス、ステータス等)を取得するためのREST APIインターフェース。ユーザー認証後の画面表示や権限チェックに使用する。
**エンドポイント:**
```
GET /api/v1/users/{user_id}
```
**リクエストヘッダー:**
```
Authorization: Bearer {access_token}
Content-Type: application/json
```
**リクエストパラメータ:**
| パラメータ名 | 型 | 必須 | 説明 |
|------------|-----|-----|------|
| user_id | string | ○ | ユーザーID |
**レスポンス例(正常時):**
```json
{
"user_id": "user_12345",
"name": "山田太郎",
"email": "yamada@example.com",
"status": "active",
"created_at": "2025-01-15T10:30:00Z"
}
```
**レスポンス例(エラー時):**
```json
{
"error_code": "USER_NOT_FOUND",
"message": "指定されたユーザーが見つかりません",
"request_id": "req_abc123"
}
```
**ステータスコード:**
- 200: 成功
- 400: リクエスト不正
- 401: 認証エラー
- 404: ユーザー不存在
- 500: サーバーエラー
**タイムアウト:** 10秒
--- プレビュー
IF-001: ユーザー情報取得API
概要:
認証基盤からユーザーの基本情報(ID、氏名、メールアドレス、ステータス等)を取得するためのREST APIインターフェース。ユーザー認証後の画面表示や権限チェックに使用する。
エンドポイント:
GET /api/v1/users/{user_id}
リクエストヘッダー:
Authorization: Bearer {access_token}
Content-Type: application/json
リクエストパラメータ:
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| user_id | string | ○ | ユーザーID |
レスポンス例(正常時):
{
"user_id": "user_12345",
"name": "山田太郎",
"email": "yamada@example.com",
"status": "active",
"created_at": "2025-01-15T10:30:00Z"
}
レスポンス例(エラー時):
{
"error_code": "USER_NOT_FOUND",
"message": "指定されたユーザーが見つかりません",
"request_id": "req_abc123"
}
ステータスコード:
- 200: 成功
- 400: リクエスト不正
- 401: 認証エラー
- 404: ユーザー不存在
- 500: サーバーエラー
タイムアウト: 10秒