장의 차례(제목 1부터 제목 5까지)를 반환하는 API입니다.
API 만들기
<도구 | API> 메뉴에서 “DOC” 유형 API를 만듭니다.
API 요청
GET 형식으로 요청해야 합니다.
요청 URL 형식입니다.
/r/api/${uuid}?action=DOC_CHAPTER_HEADING&chapterId=${chapterId}URL 파라미터 항목입니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
uuid | UUID | API UUID | 예 | 5b969d63e97cfec7 |
action | 문자열 | 작업 유형 | 예 | DOC_CHAPTER_HEADING |
chapterId | UUID | 장 아이디 | 예 | aa4efc2946b1c380 |
요청 URL 예제입니다.
/r/api/5b969d63e97cfec7?action=DOC_CHAPTER_HEADING&chapterId=aa4efc2946b1c380
API 응답
DOC_CHAPTER_HEADING 응답
JSON 형식의 응답은 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
status | 문자열 | 상태 | 예 | success | fail |
errors | Error 객체 배열 | 예외 | 아니오 | |
headings | Heading 객체 배열 | 제목 단락 목록 | 예 |
태그로 공개했다면 태그한 이후에 만든 단락은 headings 배열에 포함되지 않습니다.
Heading 객체
Heading 객체는 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
id | UUID | 단락 아이디 | 예 | 802c487204a962f2 |
type | 문자열 | 단락 유형 | 예 | heading1 |
url | 문자열 | 웹 뷰어 URL | 예 | |
content | 문자열 | 제목 내용으로 HTML 요소를 제거 | 예 | 테마 편집하기 |
headings | Heading 객체 배열 | 하위 제목 단락 목록 | 아니오 |
예외 항목
예외 항목은 다음과 같습니다.
예외 | 설명 |
|---|---|
API_HAS_NOT_DOC | API에 장이 속한 문서를 포함시키지 않았을 때 |
CHAPTER_NOT_EXIST | 장이 존재하지 않을 때. 공개한 뒤에 만든 장이나 웹을 지원하지 않는 장처럼 공개본에 없는 장일 때도 반환합니다. |
REQUIRED_PARAMETER_MISSING | API 요청에 필수 항목( |
예제
예제입니다.
{
"status": "success",
"headings": [
{
"id": "acd783b1c55fdec8",
"type": "heading1",
"url": "https://www.3rabbitz.com/book_user_guide_4_0_ko#acd783b1c55fdec8",
"content": "텍스트 단락 만들기",
"headings": [
{
"id": "caa0a001e83042f5",
"type": "heading2",
"url": "https://www.3rabbitz.com/book_user_guide_4_0_ko#caa0a001e83042f5",
"content": "텍스트 단락 내용 작성 방법"
}
]
}
]
}제목 수준이 맞지 않을 때에는 pseudo가 true인 임의의 Heading 객체를 추가합니다. 장이 제목 1 없이 제목 2 이하로 시작할 때도 맨 앞에 pseudo가 true인 제목 1 객체를 두고 그 아래에 제목을 담습니다.
{
"status": "success",
"headings": [
{
"id": "acd783b1c55fdec8",
"type": "heading1",
"content": "제목 1 단락",
"headings": [
{
"type": "heading2",
"pseudo": true,
"headings": [
{
"id": "dbcdce4f303161c4",
"type": "heading3",
"content": "제목 2 단락 없이 위치한 제목 3 단락"
}
]
}
]
}
]
}