API 이름

Update User's Information API

API 개요

이 API는 특정 사용자의 정보 일부를 업데이트하는 데 사용됩니다.

엔드포인트

PATCH /users/{id}

요청

요청 헤더

Authorization: Bearer {access_token}
Content-Type: application/json

요청 바디

{
  "name": "Updated Name",
  "email": "updatedemail@example.com"
}

매개변수

• id: 사용자의 고유 식별자 (타입: 정수) - 업데이트할 사용자의 ID

응답

응답 헤더

Content-Type: application/json

응답 바디

{
  "id": 123,
  "name": "Updated Name",
  "email": "updatedemail@example.com"
}

상태 코드

• 200: 성공적으로 사용자 정보 일부를 업데이트함
• 401: 인증되지 않은 요청
• 404: 요청한 사용자를 찾을 수 없음
• 400: 잘못된 요청 형식으로 인해 사용자 정보 일부를 업데이트할 수 없음
• 500: 서버 오류

예시

요청 예시

PATCH /users/123
Authorization: Bearer {access_token}
Content-Type: application/json

{
  "name": "Updated Name",
  "email": "updatedemail@example.com"
}

응답 예시

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 123,
  "name": "Updated Name",
  "email": "updatedemail@example.com"
}

오류 처리

• 401: 인증되지 않은 요청. 액세스 토큰이 누락되었거나 유효하지 않습니다.
• 404: 요청한 사용자를 찾을 수 없음. 지정된 ID에 해당하는 사용자가 존재하지 않습니다.
• 400: 잘못된 요청 형식으로 인해 사용자 정보 일부를 업데이트할 수 없음. 요청 바디에 잘못된 형식으로 제공된 필드가 포함되어 있을 수 있습니다.
• 500: 서버 오류. 사용자 정보 일부를 업데이트하는 동안 내부 서버 오류가 발생함

보안

이 API는 SSL/TLS를 통해 암호화된 연결을 사용합니다.

인증

이 API는 인증이 필요합니다. 액세스 토큰을 요청 헤더의 Authorization 필드에 Bearer 스키마와 함께 제공해야 합니다.

Rate Limiting

이 API는 1분당 최대 1000개의 요청을 허용합니다.

버전 관리

현재 버전: v1

변경 이력

• v1 (2023-06-01): 초기 버전