api_response_code

개요

• API Http 응답 코드

정보조회용 API 응답

• 회원 조회 등 데이터 조회 응답은 200(Ok)
• 만약 데이터가 없다면 404(Not found)
• 실패한다면 500(Internal Server error)

HTTP/1.1 200 OK
{
    "name": "testuser"
}

데이터 생성 응답

• 회원 등록 등 데이터베이스의 데이터를 생성이 성공한 201(Created)
  • 여유가 된다면 응답 헤더 Location필드에 조회할수 있는 API주소 추가
    • location: /users/1
• 실패한다면 500(Internal Server error)

HTTP/1.1 201 Created
{
    "id": 1,
    "name": "testuser"
}

데이터 수정 응답

• 회원 수정 등 데이터베이스의 데이터를 수정이 성공한 경우 200(Ok)
• 수정할 데이터가 없다면 404(Not found)
• 실패한다면 500(Internal Server error)

HTTP/1.1 200 OK
{
    "name": "testuser"
}

데이터 삭제 응답

• 회원 삭제 등 데이터베이스의 데이터베이스를 삭제가 성공한 경우 204(No Content)
  • 프론트 개발자와 협의하여 응답 데이터 생성할 수도 있음
• 수정할 데이터가 없다면 404(Not found)
• 실패한다면 500(Internal Server error)

HTTP/1.1 204 No Content
{
}

클라이언트 요청이 올바르지 않는 경우

• request body에 필드를 빼먹거나 필드 자료형이 맞지 않는 경우 400(Bad Request)
• response body에 에러 내용 전달

HTTP/1.1 400 Bad Request
{
    "error_messages": [
        "name 필드가 없습니다"
    ]
}

jwt토큰이 없는 경우

• 요청에 jwt토큰이 필요한데 요청에 jwt토큰이 없다면 401(Unauthorized)

권한 오류

• api를 실행할 권한이 없으면 403(Forbidden)

참고자료

• https://restfulapi.net/http-methods/
• https://sanghaklee.tistory.com/61