API 만들기

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

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

API 상세 화면에서 설정한 문서만을 대상으로 합니다. 한 API에 여러 문서를 추가할 수 있습니다.

API 요청

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

JSON 요청 형식입니다.

이름	유형	설명	필수 여부	예
action	문자열	작업 유형	예	CHAPTER_UPDATE
id	UUID	장 아이디	예	86ed5e400d38c511
title	문자열	제목	아니오	하드웨어
subtitle	문자열	부제목	아니오	하드웨어 요구 사항
alias	문자열	사용자 정의 아이디	아니오	hardware

장의 사용자 정의 아이디를 설정하는 예제입니다.

{
    "action": "CHAPTER_UPDATE",
    "id": "686341e93e30d856",
	"title": "하드웨어",
	"subtitle": "하드웨어 요구 사항",
    "alias": "hardware"
}

alias가 빈 값이면 사용자 아이디를 삭제합니다.

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

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

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

예외	설명
CHAPTER_NOT_EXIST	장이 존재하지 않을 때
USER_DEFINED_ID_CONFLICT	사용자 정의 아이디가 이미 존재할 때

예제입니다.

{
	"status": "success"
}