📚
【APIドキュメント】サンプル
APIドキュメント
エンドポイント
GET /users
このエンドポイントは、すべてのユーザーのリストを取得します。
リクエストパラメータ
| 名前 | 説明 | 必須 |
|---|---|---|
| limit | 取得するユーザー数の上限 | いいえ |
| offset | 取得を開始するユーザーのオフセット | いいえ |
レスポンス
成功時のレスポンスは、以下の形式で返されます。
{
"users": [
{
"id": 1,
"name": "John",
"email": "john@example.com"
},
{
"id": 2,
"name": "Jane",
"email": "jane@example.com"
}
]
}
GET /users/:id
このエンドポイントは、指定されたIDのユーザーの詳細情報を取得します。
パスパラメータ
| 名前 | 説明 |
|---|---|
| id | 取得するユーザーのID |
レスポンス
成功時のレスポンスは、以下の形式で返されます。
{
"user": {
"id": 1,
"name": "John",
"email": "john@example.com"
}
}
POST /users
このエンドポイントは、新しいユーザーを作成します。
リクエストボディ
| 名前 | 説明 | 必須 |
|---|---|---|
| name | ユーザーの名前 | はい |
| ユーザーのメールアドレス | はい |
レスポンス
成功時のレスポンスは、以下の形式で返されます。
{
"user": {
"id": 3,
"name": "Mike",
"email": "mike@example.com"
}
}
PUT /users/:id
このエンドポイントは、指定されたIDのユーザーの情報を更新します。
パスパラメータ
| 名前 | 説明 |
|---|---|
| id | 更新するユーザーのID |
リクエストボディ
| 名前 | 説明 | 必須 |
|---|---|---|
| name | 更新するユーザーの名前 | いいえ |
| 更新するユーザーのメールアドレス | いいえ |
レスポンス
成功時のレスポンスは、以下の形式で返されます。
{
"user": {
"id": 1,
"name": "John Smith",
"email": "john@example.com"
}
}
DELETE /users/:id
このエンドポイントは、指定されたIDのユーザーを削除します。
パスパラメータ
| 名前 | 説明 |
|---|---|
| id | 削除するユーザーのID |
レスポンス
成功時のレスポンスは、以下の形式で返されます。
{
"message": "User deleted successfully."
}
Discussion