API 명세 - [API 이름] API

요청

HTTP 요청

[메소드 종류] [주소]

매개변수

• 필수

필드명	설명
필드 이름	설명

• 선택

필드명	설명
필드 이름	설명

이 메소드는 요청 파라미터를 따로 필요로 하지 않습니다.

경로 변수

필드명	설명
필드 이름	설명

본문

필드명	설명
필드 이름	설명

이 메소드는 요청 본문을 따로 필요로 하지 않습니다.

• 예시

{
  들여쓰기는 스페이스 2번
}

응답

요청에 성공할 경우 이 메소드는 다음과 같은 구조의 응답을 반환합니다.

HTTP/1.1 2xx [상태 메시지]
Content-Type: application/json
Location: (201 or 202)

{
  들여쓰기는 스페이스 2번
}

(201, 202) Location 헤더는 ...의 위치를 가리킵니다.

속성

(204) 이 메소드는 요청에 성공할 경우 별도의 응답 본문을 갖지 않습니다.

필드명	설명
필드 이름	설명

오류

다음 표는 이 메소드에 대한 호출에 대한 응답으로 API가 반환할 수 있는 오류들의 정보입니다.

유형	세부정보	설명
오류 메시지(오류 코드)	대응되는 예외 이름	설명