• 상태 코드
  • 상태 코드 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

스팸으로 감지된 요청

REST API 요청이 스팸으로 감지될 수 있습니다. 요청이 스팸으로 감지되면:

• CAPTCHA 서비스가 구성되지 않은 경우, 오류 응답이 반환됩니다. 예를 들어:

  {"message":{"error":"Your snippet has been recognized as spam and has been discarded."}}
  

• CAPTCHA 서비스가 구성된 경우, 다음과 같은 응답을 받게 됩니다:

  • needs_captcha_response는 true로 설정됩니다.
  • spam_log_id와 captcha_site_key 필드가 설정됩니다.

  예를 들어:

  {"needs_captcha_response":true,"spam_log_id":42,"captcha_site_key":"REDACTED","message":{"error":"Your snippet has been recognized as spam. Please, change the content or solve the reCAPTCHA to proceed."}}
  

  • 적절한 CAPTCHA API를 사용하여 CAPTCHA 응답 값을 얻기 위해 captcha_site_key를 사용하십시오. 지원되는 것은 Google reCAPTCHA v2입니다.

  • X-GitLab-Captcha-Response 및 X-GitLab-Spam-Log-Id 헤더를 설정하여 요청을 다시 제출합니다.

    export CAPTCHA_RESPONSE="<CAPTCHA response obtained from CAPTCHA service>"
    export SPAM_LOG_ID="<spam_log_id obtained from initial REST response>"
    curl --request POST --header "PRIVATE-TOKEN: $PRIVATE_TOKEN" --header "X-GitLab-Captcha-
    Response: $CAPTCHA_RESPONSE" --header "X-GitLab-Spam-Log-Id: $SPAM_LOG_ID"
    "https://gitlab.example.com/api/v4/snippets?
    title=Title&file_name=FileName&content=Content&visibility=public"