API 만들기

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

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

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

API 요청

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

JSON 요청 형식입니다.

CHAPTER_COPY 요청
이름	유형	설명	필수 여부	예
action	문자열	작업 유형	예	CHAPTER_COPY
chapterId	UUID	복사할 장 UUID	예	686341e93e30d856
targetDocId	UUID	장을 복사할 문서 UUID. 생략하면 같은 문서에 복사합니다.	아니오	aa4efc2946b1c380
before	UUID	장 UUID. 복사한 장을 이 장 앞에 둡니다. 생략하면 맨 마지막에 위치합니다.	아니오	5b969d63e97cfec7
title	문자열	복사한 장의 이름. 생략하면 기존 장 제목에 "Copy of "를 앞에 붙입니다.	아니오	새로운 시스템 요구 사항

문서의 장을 복사하는 예제입니다.

{
    "action": "CHAPTER_COPY",
    "chapterId": "686341e93e30d856",
    "targetDocId": "aa4efc2946b1c380",
	"before": "5b969d63e97cfec7",
    "title": "새로운 시스템 요구 사항"
}

API 응답

`CHAPTER_COPY` 응답

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

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

`Chapter` 객체

`Chapter` 객체
이름	유형	설명	필수 여부	예
id	문자열	UUID	예	5b969d63e97cfec7
title	문자열	장 제목	예	새로운 시스템 요구 사항

예외

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

CHAPTER_COPY 예외 항목
예외	설명
API_HAS_NOT_DOC	API에 장이 속한 문서나 복사할 문서를 포함시키지 않았을 때
BEFORE_CHAPTER_NOT_EXIST	위치할 장이 존재하지 않거나 복사할 문서의 장이 아닐 때
CHAPTER_NOT_EXIST	장이 존재하지 않을 때
INVALID_PARAMETER	복사할 문서가 아티클일 때(`targetDocId`를 생략하고 아티클의 장을 복사할 때 포함). `title`이 2000자를 넘을 때
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목(`chapterId`)이 없을 때
TARGET_DOC_NOT_EXIST	복사할 문서가 존재하지 않을 때

예제

예제입니다.

{
	"status": "success",
	"chapter": {
		"id": "5b969d63e97cfec7",
		"title": "새로운 시스템 요구 사항"
	}
}

API 만들기

API 요청

API 응답

CHAPTER_COPY 응답

Chapter 객체

예외

예제

`CHAPTER_COPY` 응답

`Chapter` 객체