나무위키:프로젝트/봇 운용/기본 사항

1. 개요

2. 운용시 주의사항

• 운영사에서는 1초에 요청 1회만 보내는 것을 권장하고 있으며, 실제로 이보다 빠르게 요청을 보낼 경우 서버에서 요청을 거부하거나 캡챠를 표시합니다. 방법이 없는 것은 아니나 양이 너무 많은 것이 아니면 준수하는 것을 권장하고, 양이 많다면 속도를 올리기 전에 문제 발생 소지를 잘 확인해보시기 바랍니다.
• the seed engine API 문서에 없는 기능은 내부 API를 사용하거나 브라우저를 자동화하여 구현할 수 있으나, 특성상 오동작할 여지가 크므로 이에 대하여 예외 처리를 잘 해두셔야 합니다.
• 기본적으로 the seed engine의 API 사용시 기본 주소는 위키 도메인에 /api를 경로로 준 것으로, 나무위키에서는 본래 https://namu.wiki/api이고 이 경로도 동작하지만 https://wiki-api.namu.la/api를 권장한다고 운영사에서 밝힌 바 있습니다. 해당 접속 경로로는 API 요청만 가능하므로 API 요청 외의 동작을 하는 경우 적절히 대응해주어야 합니다.
• 한 요청의 크기 제한은 약 1MiB로 추정됩니다. 한글을 JSON으로 인코딩할 때 강제로 ASCII로 변환하면[1] 글자 당 6바이트로 변환되므로 한 요청에 최대 약 17만 자가 들어갑니다. 강제 ASCII 변환을 끄면 UTF-8 그대로 글자 당 3바이트를 사용하여 한 요청에 chunking 없이도 약 35만 자까지 넣을 수 있고, 나무위키에 이보다 텍스트 용량이 큰 문서는 100개를 넘지 않습니다. 1MiB보다 큰 요청을 보내려고 하는 경우 invalid request body 오류를 받게 됩니다.