분류: 바다위키
[틀:바다위키]

[틀:공식 문서]

목차

1. 개요
2. 안내
3. /api/w
4. /api/raw

1. 개요

바다위키에서 사용하는 엔진은 openNAMU입니다. 그렇기에 openNAMU에서 지원하는 기본적인 API의 대부분과 추가 API를 지원합니다. 다음은 각각 API의 설명입니다. 아직 API 요청에 특별한 키나 헤더는 필요하지 않으나, 과도한 요청이나 서버에 무리가 올 정도의 요청을 반복하면 해당 아이피로의 요청 차단 및 이후 API 요청 시 추가 키를 발급받도록 조치할 예정입니다.

2. 안내

바다위키는 기술적인 문제로 시스템 문서가 아닌 일반 문서 한정으로, 문서가 존재하지 않아도 200을 반환합니다. status_code 등의 서버 상태를 사용하지 않는 것을 권장합니다. 없는 문서는 404를 반환하는 API를 따로 준비 중에 있습니다.

3. /api/w

렌더링 된 문서 내용을 불러옵니다. { "data": "문서의 HTML", "js_data": "렌더링에서 사용된 js (include 등)", "title": "요청한 문서의 제목" }

https://bada.wiki/api/w/바다위키 요청 시 다음 값 반환

{
"data": "<table class=\"\" style=\"width: 350px;float: right;border: #00AFFF 2px solid;\"><tbody>(생략)",
"js_data": "<script>render_html('include_1-');</script>",
"title": "바다위키"
}

4. /api/raw

문서의 원본을 불러옵니다. { "data": "문서의 RAW", "title": "요청한 문서의 제목" }

https://bada.wiki/api/raw/바다위키 요청 시 다음 값 반환

{
"data": [[분류:바다위키]][[분류:위키]]\r\n[include(틀:다른 뜻1, other1= 2017년에 개설했던 엔하계 위키, rd1= 바다위키(2017년))]\r\n[include(틀:한국어 위키/엔하계)]\r\n||<-2><tablealign=right><tablewidth=400><tablebordercolor=#00AFFF>(생략)",
"title": "바다위키"
}



위키 내 모든 일반 문서는 CC BY-NC-SA 2.0 KR에 따라 이용할 수 있습니다. (단, 라이선스가 명시된 일부 문서 및 삽화 제외)
기여하신 문서의 저작권은 각 기여자에게 있으며, 각 기여자는 기여하신 부분의 저작권을 갖습니다.

바다위키에서 오픈소스로 배포하지 않은 직접 개발한 UI, 디자인 및 기능에는 저작권이 존재합니다.
오픈소스로 배포하지 않은 저작물을 무단으로 사용하는 것은 저작권 위반이며 적발 시 법적 대응 등의 조치를 취할 수 있습니다.
최근 변경
                   
최근 토론