API 만들기

<도구 | API> 메뉴에서 “DOC” 유형 API를 만듭니다.

다양한 쓰리래빗츠 북 API를 만드는 방법을 설명합니다.

API 상세 화면에서 설정한 문서만을 대상으로 합니다. 한 API에 여러 문서를 추가할 수 있습니다. 대상으로 "공개한 문서"를 선택하면 호출 시점에 공개되어 있는 문서만 대상으로 하고, 공개하지 않은 문서에는 API_HAS_NOT_DOC 예외를 반환합니다.

API 요청

POST 형식으로 요청해야 합니다.

JSON 요청 형식입니다.

DOC_UPDATE_PARAMETER 요청 파라미터
이름	유형	설명	필수 여부	예
action	문자열	작업 유형	예	DOC_UPDATE_PARAMETER
id	UUID	문서 아이디	예	0168a36b30c18e93
parameter	JSON 객체	파라미터	예

문서를 변경하는 예제입니다.

{
    "action": "DOC_UPDATE_PARAMETER",
    "id": "0168a36b30c18e93",
    "parameter": {
        "name": "매뉴얼웍스 6.0",
    	"version": "6.0.2"
    }
}

parameter 객체의 키에는 파라미터 이름을 입력하고 값에는 파라미터 값을 입력합니다. 다음을 참고합니다.

보내지 않은 파라미터는 그대로 둡니다. 기존 파라미터의 순서를 지키고, 새 파라미터는 뒤에 붙입니다.
값을 빈 문자열이나 null로 보내면 그 파라미터를 삭제합니다.
숫자나 참거짓 값으로 보내도 문자열로 저장합니다. 값 안의 줄 바꿈은 공백으로 바꿉니다.
parameter가 JSON 객체가 아니거나, 값에 객체나 배열을 보내거나, 이름이 비어 있거나 이름에 = 또는 줄 바꿈이 있으면 INVALID_PARAMETER 예외를 반환하고 아무것도 바꾸지 않습니다.

JSON 형식의 응답은 다음과 같습니다.

`DOC_UPDATE_PARAMETER` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
errors	Error 객체 배열	예외	아니오

예외 항목은 다음과 같습니다.

DOC_UPDATE_PARAMETER 예외 항목
예외	설명
API_HAS_NOT_DOC	API에 해당 문서를 포함시키지 않았을 때
DOC_NOT_EXIST	문서가 존재하지 않을 때
INVALID_PARAMETER	`parameter`가 JSON 객체가 아니거나 파라미터 이름이나 값이 형식에 맞지 않을 때
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목이 없을 때

예제입니다.

{
	"status": "success"
}