• 상태 코드
  • 상태 코드 400
• HTTP 응답 헤더 포함
• HTTP 종료 코드 포함

REST API 문제 해결

REST API를 사용하는 중에 문제가 발생할 수 있습니다.

문제 해결을 위해 REST API 상태 코드를 참조해야 합니다. 또한 HTTP 응답 헤더와 종료 코드를 포함하는 것이 도움이 될 수 있습니다.

상태 코드

GitLab REST API는 맥락 및 동작에 따라 모든 응답에 상태 코드를 반환합니다. 요청에 의해 반환된 상태 코드는 문제 해결 시 유용할 수 있습니다.

다음 표는 API 기능이 일반적으로 어떻게 작동하는지에 대한 개요를 제공합니다.

다음 표는 API 요청에 대한 가능한 반환 코드를 보여줍니다.

상태 코드 400

API를 사용하는 중에 유효성 검사 오류가 발생할 수 있으며, 이 경우 API는 HTTP 400 오류를 반환합니다.

이러한 오류는 다음 경우에 발생합니다.

• API 요청의 필수 속성이 누락된 경우 (예: 이슈의 제목이 주어지지 않음).
• 속성이 유효성 검사를 통과하지 못한 경우 (예: 사용자 소개가 너무 긴 경우).

속성이 누락된 경우 다음과 같이 수신합니다:

HTTP/1.1 400 Bad Request
Content-Type: application/json
{
    "message":"400 (Bad request) \"title\" not given"
}

유효성 검사 오류가 발생하는 경우 오류 메시지는 다릅니다. 이러한 메시지는 유효성 검사 오류의 모든 세부 정보를 보유합니다:

HTTP/1.1 400 Bad Request
Content-Type: application/json
{
    "message": {
        "bio": [
            "is too long (maximum is 255 characters)"
        ]
    }
}

이렇게 하면 오류 메시지가 기계에서 읽을 수 있게 됩니다. 이 형식은 다음과 같이 설명할 수 있습니다:

{
    "message": {
        "<property-name>": [
            "<error-message>",
            "<error-message>",
            ...
        ],
        "<embed-entity>": {
            "<property-name>": [
                "<error-message>",
                "<error-message>",
                ...
            ],
        }
    }
}

HTTP 응답 헤더 포함

문제 해결 시 HTTP 응답 헤더는 추가 정보를 제공할 수 있습니다.

응답에 HTTP 응답 헤더를 포함하려면 --include 옵션을 사용하세요:

curl --include "https://gitlab.example.com/api/v4/projects"
HTTP/2 200
...

HTTP 종료 코드 포함

API 응답의 HTTP 종료 코드는 문제 해결 시 추가 정보를 제공할 수 있습니다.

HTTP 종료 코드를 포함하려면 --fail 옵션을 사용하세요:

curl --fail "https://gitlab.example.com/api/v4/does-not-exist"
curl: (22) The requested URL returned error: 404