リクエストパラメータ
| パラメータ |
項目名 |
型 |
必須 |
説明 |
値の例 |
| user_id |
ユーザーID |
整数 |
○ |
ユーザのID |
3 |
リクエスト例
http://localhost:6000/api/v1/users/3
リクエストボディ
| フィールド |
項目名 |
型 |
必須 |
説明 |
値の例 |
| id |
ユーザーID |
整数 |
○ |
説明 |
3 |
| name |
ニックネーム |
文字 |
○ |
説明 |
"アンミカ" |
| thumnail |
プロフィール画像 |
フラグ |
○ |
ユーザーのプロフィール画像 |
“<https://example.com>” |
| description |
自己紹介文 |
文字列 |
○ |
ユーザーの自己紹介文 |
"白が200色わかる方" |
| external_links |
外部サイトリンク |
配列 |
× |
外部サイトのリンクたち |
[] |
| url |
url |
文字列 |
○ |
URL |
"<https://example.com>" |
レスポンスボディ
| フィールド |
項目名 |
型 |
必須 |
説明 |
値の例 |
| id |
ID |
整数 |
○ |
ユーザーのID |
3 |
| name |
名前 |
文字列 |
○ |
ユーザーの名前(ニックネーム) |
"アンミカ" |
| description |
自己紹介文 |
文字列 |
○ |
ユーザーの自己紹介文 |
"白が200色わかる方" |
| thumbnail |
サムネイル画像 |
文字列 |
○ |
シェフのサムネイル画像URL |
"<https://example.com>" |
| external_links |
外部サイトリンク |
配列 |
× |
外部サイトのリンクたち |
[] |
| url |
url |
文字列 |
○ |
URL |
"<https://example.com>" |
| type |
サイト種別 |
文字列 |
○ |
インスタかTwitterかなど |
"Twitter" |
レスポンス例
{
"id": 3,
"name": "アンミカ",
"description": "白が200色わかる方",
"thumbnail": "<https://example.com>",
"external_links": [
{
"url": "<https://example.com>",
"type": "twitter",
}
]
}