이미지 처리(Files)

1. 프로필 사진 업로드 URL 요청

1.1. 성공 200

http-request

GET /users/profiles/avatars HTTP/1.1
Authorization: AccessToken
Host: docs.api.com

http-response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 89

{
  "avatarId" : 1,
  "preSignedUrl" : "https://aws.filename.png/secret=aD@!DSSFZcs"
}

Path	Type	Description
avatarId	Number	등록된 avatarId
preSignedUrl	String	해당 경로로 파일을 업로드해야 합니다.

1.2. 실패 404

데이터베이스에서 유저 정보를 찾을 수 없음.

http-request

GET /users/profiles/avatars HTTP/1.1
Authorization: AccessToken
Host: docs.api.com

http-response

HTTP/1.1 404 Not Found
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 145

{
  "status" : 404,
  "code" : "USER_NOT_FOUND",
  "message" : "The user is a user who has left or does not exist.",
  "validation" : null
}

1.3. 실패 409

AWS S3와의 연결 문제로 인한 실패.

http-request

GET /users/profiles/avatars HTTP/1.1
Authorization: AccessToken
Host: docs.api.com

http-response

HTTP/1.1 409 Conflict
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 154

{
  "status" : 409,
  "code" : "CAN_NOT_ACCESS_S3",
  "message" : "unable to access amazon s3, contract your administrator.",
  "validation" : null
}

---

2. 게시글 이미지 업로드 URL 요청

2.1. 성공 200

http-request

GET /files HTTP/1.1
Authorization: AccessToken
Host: docs.api.com

http-response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 87

{
  "fileId" : 1,
  "preSignedUrl" : "https://aws.filename.png/secret=aD@!DSSFZcs"
}

Path	Type	Description
fileId	Number	등록된 file Id
preSignedUrl	String	해당 경로로 파일을 업로드해야 합니다.

2.2. 실패 409

AWS S3와의 연결 문제로 인한 실패.

http-request

GET /files HTTP/1.1
Authorization: AccessToken
Host: docs.api.com

http-response

HTTP/1.1 409 Conflict
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 154

{
  "status" : 409,
  "code" : "CAN_NOT_ACCESS_S3",
  "message" : "unable to access amazon s3, contract your administrator.",
  "validation" : null
}

---

3. 프로필 이미지 삭제

3.1. 성공 204

http-request

DELETE /users/profiles/avatars HTTP/1.1
Authorization: AccessToken
Host: docs.api.com

http-response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

3.2. 실패 404

유저의 이미지에 대한 정보를 Database에서 찾을 수 없음.

http-request

DELETE /users/profiles/avatars HTTP/1.1
Authorization: AccessToken
Host: docs.api.com

http-response

HTTP/1.1 404 Not Found
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 109

{
  "status" : 404,
  "code" : "FILE_NOT_FOUND",
  "message" : "FILE_NOT_FOUND",
  "validation" : null
}

3.3. 실패 409

AWS S3와의 연결 문제로 인한 실패.

http-request

DELETE /users/profiles/avatars HTTP/1.1
Authorization: AccessToken
Host: docs.api.com

http-response

HTTP/1.1 409 Conflict
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 154

{
  "status" : 409,
  "code" : "CAN_NOT_ACCESS_S3",
  "message" : "unable to access amazon s3, contract your administrator.",
  "validation" : null
}