미디어위키 API 도움말

이 페이지는 자동으로 생성된 미디어위키 Action API 설명문서입니다.

일반 정보

상태: 이 페이지에 보이는 모든 기능은 정상적으로 작동하지만, API는 여전히 활발하게 개발되고 있으며, 언제든지 변경될 수 있습니다. 업데이트 공지를 받아보려면 mediawiki-api-announce 메일링 리스트를 구독하세요.

잘못된 요청: API에 잘못된 요청이 전송되면 "MediaWiki-API-Error" 키가 포함된 HTTP 헤더가 전송되며 반환되는 헤더와 오류 코드의 값은 모두 동일한 값으로 설정됩니다. 자세한 정보에 대해서는 API:오류와 경고를 참조하새요.

테스트하기: API 요청 테스트를 용이하게 하려면, Special:ApiSandbox를 보세요.

요청 수단

Action API 요청에는 GET 및 POST 메서드를 사용할 수 있습니다. 매개변수가 포함된 URL의 길이가 길이 제한(일반적으로 8000바이트)을 초과하거나, 특정 모듈이 POST 요청만 허용하는 경우가 아니라면, 요청을 더 빠른 레플리카 서버로 라우팅하고 응답을 캐시할 수 있는 GET 메서드를 우선적으로 사용하세요.

POST 요청의 매개변수는 요청 URL의 쿼리 부분(GET 요청과 유사)과 POST 요청 본문에 모두 포함될 수 있으며, 하나의 요청에서 두 방식을 혼합하여 사용하는 것도 허용됩니다. 비밀번호와 같은 특정 매개변수는 요청 본문에 반드시 포함되어야 합니다. 동일한 매개변수가 URL의 일부로 전송되고 요청 본문에도 포함된 경우, 두 곳 모두에서 동일한 값을 가져야 합니다.

데이터 유형

미디어위키의 입력은 NFC 정규화 UTF-8인 것이 좋습니다. 미디어위키는 다른 입력의 변환을 시도할 수 있지만 일부 작업(MD5 검사를 수반한 편집 등)을 실패할 수 있습니다.

여러 값을 받는 매개변수는 보통 파이프 문자를 사용하여 구분되는 값으로 제출합니다. (예: param=value1|value2 또는 param=value1%7Cvalue2) 값에 파이프 문자가 포함되어야 하는 경우 U+001F(단위 구분자)를 구분자로, 값의 접두사를 U+001F로 사용하십시오. (예: param=%1Fvalue1%1Fvalue2)

API 요청의 일부 매개변수 유형은 추가 설명이 필요합니다:

boolean: 불리언 매개변수는 HTML 체크상자처럼 동작합니다: 매개변수를 지정하면 값에 관계 없이 true로 간주됩니다. false 값의 경우 매개변수 전체를 제외합니다.
expiry: 만료 값은 상대값(예시: 5 months 또는 2 weeks) 또는 절대값(예시: 2014-09-18T12:34:56Z)이 될 수 있습니다. 만료 값이 없는 경우 infinite, indefinite, infinity, 또는 never를 사용하세요.
timestamp: 타임스탬프는 여러 형식으로 지정할 수 있습니다. 자세한 사항은 mediawiki.org에 문서화된 타임스탬프 라이브러리 입력 포맷을 참고하십시오. ISO 8601 날짜 및 시간이 권장됩니다: 2001-01-15T14:56:00Z. 문자열 now를 사용하여 현재 시간을 지정할 수 있습니다.

제한

대부분의 API 모듈은 다중 값 매개변수에 최대 50개 입력을 허용할 수 있으며, 쿼리당 500개 결과 (느린 쿼리의 경우 50개 결과) 를 반환할 수 있습니다.

\apihighlimits 권리(봇 그리고 관리자)를 가지고 있는 사용자의 경우, 제한이 500개 입력과 5,000개 결과 (느린 쿼리의 경우 500개 결과)로 증가합니다.

틀 매개변수

틀 매개변수는 다른 일부 매개변수의 개별 값에 대한 API 모듈에 값이 필요한 경우를 지원합니다. 이를테면 과일을 요청하는 API 모듈이 있다면 fruits 매개변수를 사용하여 요청할 과일을 지정할 수 있으며 틀 매개변수 {fruit}-quantity를 사용하여 요청할 과일의 수를 지정할 수 있습니다. 사과 1개, 바나나 5개, 딸기 20개를 원하는 API 클라이언트는 fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20와 같은 요청을 수행할 수 있습니다.

메인 모듈

출처: MediaWiki
라이선스: GPL-2.0-or-later

Specify the action to perform, the format of the response, and options that apply to all API modules.

특정 매개변수:

action

수행할 작업입니다. 이 매개변수는 디버깅, 분석, 요청 라우팅 또는 필터링의 편의성을 위해 (POST 본문이 아닌) 요청 URL의 일부로써 전송되어야 합니다.

abusefiltercheckmatch: 편집 필터가 변수 집합, 편집, 또는 기록된 편집 필터 이벤트와 일치하는지 확인합니다.
abusefilterchecksyntax: 편집 필터의 구문을 검사합니다.
abusefilterevalexpression: 편집 필터의 식을 검사합니다.
abusefilterunblockautopromote: 편집 필터 동작으로 인해 자동 인증을 받지 못하도록 제한된 사용자의 제한을 해제합니다.
abuselogprivatedetails: 악용 기록 항목의 비공개 세부 사항을 봅니다.
acquiretempusername: 임시 계정 생성이 활성화되고 현재 사용자가 로그아웃된 경우 임시 사용자의 사용자 이름을 획득하여 현재 세션에 보관합니다. 이름이 이미 숨겨져 있으면 동일한 이름을 반환합니다.
antispoof: 안티스푸프의 표준화 검사를 사용하여 사용자명을 검사합니다.
block: 사용자를 차단합니다.
centralauthtoken: 통합된 위키에서 인증 요청을 보내는 데 필요한 centralauthtoken을 받아옵니다.
centralnoticecdncacheupdatebanner: 익명 사용자, 요청된 배너, 그리고 언어와 관련하여 CDN(프론트엔드) 캐시에 저장된 배너 콘텐츠의 새로 고침을 요청합니다
centralnoticechoicedata: 지정된 프로젝트와 언어를 위한 배너 선택에 필요한 데이터를 가져옵니다
centralnoticequerycampaign: 캠페인을 위한 모든 구성 설정을 가져옵니다.
changeauthenticationdata: 현재 사용자의 인증 데이터를 변경합니다.
changecontentmodel: 문서의 콘텐츠 모델을 변경
checktoken: action=query&meta=tokens의 토큰의 유효성을 확인합니다.
clearhasmsg: 현재 사용자의 hasmsg 플래그를 비웁니다.
clientlogin: 상호작용 플로우를 이용하여 위키에 로그인합니다.
communityconfigurationedit: Change the content of a configuration provider in Community configuration
compare: 두 문서 간의 차이를 가져옵니다.
createaccount: 새 사용자 계정을 만듭니다.
createlocalaccount: 로컬 계정을 강제로 생성합니다. 통합 계정이 존재해야 합니다.
delete: 문서를 삭제합니다.
deleteglobalaccount: 통합 사용자 계정을 삭제합니다.
discussiontoolsedit: 토론 문서에 메시지를 게시합니다.
discussiontoolsfindcomment: ID 또는 이름으로 댓글을 찾습니다.
discussiontoolsgetsubscriptions: 지정된 주제의 구독 상태를 가져옵니다.
discussiontoolssubscribe: 주제에 관한 알림을 수신하기 위해 구독(또는 구독 해지)을 합니다.
discussiontoolsthank: 의견에 대해 공개적인 감사 표현 알림을 보냅니다.
echocreateevent: 사용자에게 알림을 수동으로 보냅니다
echomarkread: 현재 사용자의 알림을 읽은 것으로 표시합니다.
echomarkseen: 현재 사용자가 알림을 본 것으로 표시합니다.
echomute: 특정 사용자나 문서로부터 오는 알림을 끄거나 다시 켭니다.
edit: 문서를 만들고 편집합니다.
editmassmessagelist: 대량 메시지 수신자 목록을 편집합니다.
emailuser: 사용자에게 이메일을 보냅니다.
expandtemplates: 위키텍스트 안에 모든 틀을 확장합니다.
featuredfeed: 알찬 글 피드를 반환합니다.
feedcontributions: 사용자 기여 피드를 반환합니다.
feedrecentchanges: 최근 바뀜 피드를 반환합니다.
feedwatchlist: 주시문서 목록 피드를 반환합니다.
filerevert: 파일을 이전 판으로 되돌립니다.
globalblock: 사용자를 전역 차단하거나 해제합니다.
globalpreferenceoverrides: 현재 사용자의 전역 환경 설정의 로컬 재정의를 변경합니다.
globalpreferences: 현재 사용자의 통합 계정 환경 설정을 변경합니다.
globaluserrights: 전역 사용자 그룹에서 사용자를 추가/제거합니다.
help: 지정된 모듈의 도움말을 표시합니다.
imagerotate: 이 모듈은 비활성화되었습니다.
import: 다른 위키나 XML 파일로부터 문서를 가져옵니다.
jsonconfig: JsonConfig 하위 시스템으로의 직접 접근을 허용합니다.
languagesearch: 임의의 스크립트에서 언어 이름을 검색합니다.
linkaccount: 서드파티 제공자의 계정을 현재 사용자와 연결합니다.
login: 로그인한 다음 인증 쿠키를 가져옵니다.
logout: 로그아웃하고 세션 데이터를 지웁니다.
managetags: 변경 태그에 관한 관리 작업을 수행합니다.
massmessage: 문서 목록에 메시지를 보냅니다.
mergehistory: 문서 역사를 합칩니다.
move: 문서를 이동합니다.
opensearch: OpenSearch 프로토콜을 이용하여 위키를 검색합니다.
options: 현재 사용자의 환경 설정을 변경합니다.
paraminfo: API 모듈의 정보를 가져옵니다.
parse: 내용을 변환하고 출력을 반환합니다.
patrol: 문서나 판을 점검합니다.
protect: 문서의 보호 수준을 변경합니다.
purge: 주어진 제목을 위한 캐시를 새로고침합니다.
query: 미디어위키의 데이터 및 정보를 가져옵니다.
removeauthenticationdata: 현재 사용자의 인증 데이터를 제거합니다.
resetpassword: 비밀번호 재설정 이메일을 사용자에게 보냅니다.
revisiondelete: 판을 삭제하거나 복구합니다.
rollback: 문서의 마지막 편집을 취소합니다.
rsd: RSD (Really Simple Discovery) 스키마를 내보냅니다.
setglobalaccountstatus: 통합 사용자의 숨기거나 잠급니다 (또는 숨김 해제하거나 잠금 해제).
setnotificationtimestamp: 주시 중인 문서의 알림 타임스탬프를 업데이트합니다.
setpagelanguage: 문서의 언어를 변경합니다.
shortenurl: 긴 URL을 짧게 줄입니다.
sitematrix: 위키미디어 사이트 목록을 가져옵니다.
spamblacklist: 스팸 차단 목록에 대해 하나 이상의 URL의 유효성을 확인합니다.
streamconfigs: 이벤트 스트림 구성을 노출합니다. formatversion=2의 format=json만 반환합니다.
strikevote: 관리자가 투표를 제거하거나 제거를 취소할 수 있게 합니다.
tag: 개별 판이나 기록 항목에서 변경 태그를 추가하거나 제거합니다.
templatedata: TemplateData 확장 기능에 의해 저장된 데이터를 가져옵니다.
thank: 편집자에게 감사 알림을 보냅니다.
titleblacklist: TitleBlacklist에 대해 문서 제목, 파일 이름, 사용자 이름을 검사합니다.
torblock: Tor 출구 노드로서 IP 주소가 차단되었는지 확인합니다.
transcodereset: 'transcode-reset' 권한이 있는 사용자는 코드 변환 작업을 초기화하고 다시 실행할 수 있습니다.
unblock: 사용자를 차단 해제합니다.
undelete: 삭제된 문서의 판을 복구합니다.
unlinkaccount: 현재 사용자에 연결된 타사 계정을 제거합니다.
upload: 파일을 업로드하거나 대기 중인 업로드의 상태를 가져옵니다.
userrights: 사용자의 그룹 권한을 변경합니다.
validatepassword: 위키의 비밀번호 정책에 근간하여 비밀번호를 확인합니다.
watch: 현재 사용자의 주시문서 목록에서 문서를 추가하거나 제거합니다.
webapp-manifest: 웹앱 매니페스트를 반환합니다.
webauthn: 등록/인증 과정 중에 서버와 클라이언트 간 통신을 하기 위한 API 모듈입니다.
wikifunctions_run: 함수 호출 실행
wikilambda_fetch: Z객체의 JSON 모델을 가져옵니다.
abstractwiki_fetch_section: 내부 매개변수입니다. 주어진 주제 Qid(위키데이터 항목 ID), 섹션 Qid, 언어 Zid 및 날짜에 대해 현재 사용 가능한 추상 위키백과 렌더링 조각을 요청합니다. 또는 (특별 권한이 있는 경우에만) 요청에 전달된 조각 배열의 현재 사용 가능한 렌더링 출력을 요청할 수 있으며, 이는 현재 저장된 버전과 다를 수 있습니다.

이 요청은 절대 차단되지 않습니다. 요청된 조각 중 하나라도 준비되지 않은 경우, 해당 조각에 대해 반환된 값에는 "대기 중" 플래그가 true로 설정됩니다.

응답은 항상 요청된 개수만큼 결과를 반환합니다. 예를 들어, "fragments" 매개변수가 비어 있고 요청된 섹션에 N개의 조각이 있는 경우, N개의 조각이 모두 반환됩니다. 마찬가지로, "fragments" 매개변수에 M개의 조각을 요청하면 M개의 항목이 반환됩니다.

abstractwiki_run_fragment: 내부 매개변수입니다. 주어진 위키데이터 항목 ID, 언어 ZID 및 날짜에 대한 추상 위키백과 콘텐츠 조각을 렌더링합니다.
bouncehandler: 내부 매개변수입니다. 반송된 이메일을 수신한 후에 수신에 실패한 받는 사람을 위해 메일을 처리합니다.
categorytree: 내부 매개변수입니다. CategoryTree 확장 기능을 위한 내부 모듈입니다.
chartinfo: 내부 매개변수입니다. 현재 차트 페이지별 고유 사용 횟수를 가져옵니다. 같은 페이지에서 같은 차트를 여러 번 사용하는 것은 단일 사용으로 간주됩니다.
cirrus-check-sanity: 내부 매개변수입니다. 검색 색인의 다양한 페이지 ID의 정확성에 대한 보고서입니다
cirrus-config-dump: 내부 매개변수입니다. CirrusSearch 구성의 덤프입니다.
cirrus-profiles-dump: 내부 매개변수입니다. 이 위키의 CirrusSearch 프로필의 덤프입니다.
cirrus-schema-dump: 내부 매개변수입니다. 이 위키의 CirrusSearch 스키마(설정 및 매핑) 덤프입니다.
codemirror-validate: 내부 매개변수입니다. 지정된 내용의 유효성 오류를 검사합니다
collection: 내부 매개변수입니다. 위키 사용자의 모음집에 다양한 동작을 수행하기 위한 API 모듈입니다.
cspreport: 내부 매개변수입니다. 브라우저가 콘텐츠 보안 정책의 위반을 보고하기 위해 사용합니다. 이 모듈은 SCP를 준수하는 웹 브라우저에 의해 자동으로 사용될 때를 제외하고는 사용해서는 안 됩니다.
discussiontoolscompare: 내부 매개변수입니다. 두 페이지 판 사이의 의견 변경사항에 관한 정보를 가져옵니다.
discussiontoolspageinfo: 내부 매개변수입니다. 토론 도구 초기화에 필요한 메타데이터를 반환합니다.
discussiontoolspreview: 내부 매개변수입니다. 토론 문서의 메시지를 미리 봅니다.
editcheckreferenceurl: 내부 매개변수입니다. Check the status of a URL for use as a reference.
fancycaptchareload: 내부 매개변수입니다. 새 FancyCaptcha를 가져옵니다.
jsondata: 내부 매개변수입니다. 지역화된 JSON 데이터를 검색합니다.
jsontransform: 내부 매개변수입니다. 루아 함수로 변환된 JSON 데이터를 검색합니다.
parser-migration: 내부 매개변수입니다. 서로 다른 2개의 파서 구성을 사용하여 문서의 구문을 분석합니다.
readinglists: 내부 매개변수입니다. 읽기 목록 쓰기 명령입니다.
sanitize-mapdata: 내부 매개변수입니다. Kartographer 확장을 위한 데이터 유효성 확인을 수행합니다
scribunto-console: 내부 매개변수입니다. Scribunto 콘솔에서 XHR 요청을 서비스하기 위한 내부 모듈입니다.
securepollauth: 내부 매개변수입니다. 투표에 대한 접근 권한을 부여하기 전에 원격 위키가 사용자를 인증할 수 있도록 합니다.
stashedit: 내부 매개변수입니다. 공유된 캐시에서 편집을 준비합니다.
timedtext: 내부 매개변수입니다. <track> 요소들의 사용에 대한 타임드 텍스트 내용을 제공합니다
ulslocalization: 내부 매개변수입니다. 주어진 언어로 ULS의 지역화를 가져옵니다.
ulssetlang: 내부 매개변수입니다. 사용자의 주로 사용하는 인터페이스 언어를 업데이트합니다.
visualeditor: 내부 매개변수입니다. Parsoid 서비스에서 문서를 위해 HTML5를 반환합니다.
visualeditoredit: 내부 매개변수입니다. HTML5 페이지를 미디어위키로 저장합니다. (Parsoid 서비스를 통해 위키텍스트로 변환)
wikifunctions_html_sanitiser: 내부 매개변수입니다. Wikifunctions.org 및 클라이언트 위키미디어 위키에서 사용자에게 표시하기 위해 HTML 문자열을 새니타이즈하기 위한 API입니다.
wikilambda_edit: 내부 매개변수입니다. Z객체을 생성하거나 편집합니다.
wikilambda_function_call: 내부 매개변수입니다. 함수 오케스트레이터를 호출함으로써 함수를 호출합니다
wikilambda_perform_test: 내부 매개변수입니다. Z함수에 대한 테스트 결과를 조회하기 위한 종단점입니다. Z함수, Z구현 목록, Z테스터 목록을 인수로 받습니다. 함수, 구현 또는 테스터에 대한 ZID 목록 또는 전체 Z객체를 인수로 받을 수 있습니다. 백엔드 캐시 사용 여부를 결정하는 키도 인수로 받습니다.
wikilambda_supported_programming_languages: 내부 매개변수입니다. 평가자가 지원하는 프로그래밍 언어를 검색합니다
wikimediaeventsblockededit: 내부 매개변수입니다. 차단된 편집 시도의 기록 정보입니다
wikimediaeventshcaptchaeditattempt: 내부 매개변수입니다. hCaptcha 상황에서 편집을 마치지 못한 경우 편집 차이를 기록합니다

다음 값 중 하나: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, acquiretempusername, antispoof, block, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, communityconfigurationedit, compare, createaccount, createlocalaccount, delete, deleteglobalaccount, discussiontoolsedit, discussiontoolsfindcomment, discussiontoolsgetsubscriptions, discussiontoolssubscribe, discussiontoolsthank, echocreateevent, echomarkread, echomarkseen, echomute, edit, editmassmessagelist, emailuser, expandtemplates, featuredfeed, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, help, imagerotate, import, jsonconfig, languagesearch, linkaccount, login, logout, managetags, massmessage, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, sitematrix, spamblacklist, streamconfigs, strikevote, tag, templatedata, thank, titleblacklist, torblock, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, webauthn, wikifunctions_run, wikilambda_fetch, abstractwiki_fetch_section, abstractwiki_run_fragment, bouncehandler, categorytree, chartinfo, cirrus-check-sanity, cirrus-config-dump, cirrus-profiles-dump, cirrus-schema-dump, codemirror-validate, collection, cspreport, discussiontoolscompare, discussiontoolspageinfo, discussiontoolspreview, editcheckreferenceurl, fancycaptchareload, jsondata, jsontransform, parser-migration, readinglists, sanitize-mapdata, scribunto-console, securepollauth, stashedit, timedtext, ulslocalization, ulssetlang, visualeditor, visualeditoredit, wikifunctions_html_sanitiser, wikilambda_edit, wikilambda_function_call, wikilambda_perform_test, wikilambda_supported_programming_languages, wikimediaeventsblockededit, wikimediaeventshcaptchaeditattempt 또는 다른 문자열: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, acquiretempusername, antispoof, block, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, communityconfigurationedit, compare, createaccount, createlocalaccount, delete, deleteglobalaccount, discussiontoolsedit, discussiontoolsfindcomment, discussiontoolsgetsubscriptions, discussiontoolssubscribe, discussiontoolsthank, echocreateevent, echomarkread, echomarkseen, echomute, edit, editmassmessagelist, emailuser, expandtemplates, featuredfeed, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, help, imagerotate, import, jsonconfig, languagesearch, linkaccount, login, logout, managetags, massmessage, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, sitematrix, spamblacklist, streamconfigs, strikevote, tag, templatedata, thank, titleblacklist, torblock, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, webauthn, wikifunctions_run, wikilambda_fetch, abstractwiki_fetch_section, abstractwiki_run_fragment, bouncehandler, categorytree, chartinfo, cirrus-check-sanity, cirrus-config-dump, cirrus-profiles-dump, cirrus-schema-dump, codemirror-validate, collection, cspreport, discussiontoolscompare, discussiontoolspageinfo, discussiontoolspreview, editcheckreferenceurl, fancycaptchareload, jsondata, jsontransform, parser-migration, readinglists, sanitize-mapdata, scribunto-console, securepollauth, stashedit, timedtext, ulslocalization, ulssetlang, visualeditor, visualeditoredit, wikifunctions_html_sanitiser, wikilambda_edit, wikilambda_function_call, wikilambda_perform_test, wikilambda_supported_programming_languages, wikimediaeventsblockededit, wikimediaeventshcaptchaeditattempt

기본값: help

format

출력값의 형식입니다.

json: 데이터를 JSON 형식으로 출력합니다.
jsonfm: 데이터를 JSON 포맷으로 출력합니다. (HTML의 가독성 증가)
none: 아무 것도 출력하지 않습니다.
rawfm: 디버깅 요소를 포함하여 데이터를 JSON 형식으로 출력합니다. (HTML의 가독성 증가)
xml: 데이터를 XML 형식으로 출력합니다.
xmlfm: 데이터를 XML 포맷(가독성 높은 HTML 방식)으로 출력합니다.

다음 값 중 하나: json, jsonfm, none, rawfm, xml, xmlfm 또는 다른 문자열: json, jsonfm, none, rawfm, xml, xmlfm

기본값: jsonfm

maxlag

최대 랙은 미디어위키가 데이터베이스 복제된 클러스터에 설치되었을 때 사용될 수 있습니다. 특정한 작업이 사이트 복제 랙을 유발할 때, 이 매개변수는 클라이언트가 복제 랙이 설정된 숫자 아래로 내려갈 때까지 기다리도록 지시합니다. 과도한 랙의 경우, maxlag 오류 코드와 $host 대기 중: $lag초 지연되었습니다 메시지가 제공됩니다.
매뉴얼: Maxlag 매개변수에서 더 많은 정보를 얻을 수 있습니다.

유형: 정수

smaxage

s-maxage HTTP 캐시 컨트롤 헤더를 설정합니다. 오류는 캐시되지 않습니다.

유형: 정수

값은 0 이상이어야 합니다.

기본값: 0

maxage

max-age HTTP 캐시 컨트롤 헤더를 설정합니다. 오류는 캐시되지 않습니다.

유형: 정수

값은 0 이상이어야 합니다.

기본값: 0

assert

user 플래그가 설정되어 있다면 로그인(임시 사용자도 포함) 여부를 체크하며, anon 플래그가 설정되어 있다면 로그인되지 않았는지 확인하고, bot 플래그가 설정되어 있다면 봇 사용자 권한이 설정되어 있는지 확인합니다.

다음 값 중 하나: anon, bot, user 또는 다른 문자열: anon, bot, user

assertuser

현재 사용자가 지명된 사용자인지 확인합니다.

형태: 사용자 이름 그리고 임시 사용자 모두에 따른 사용자

requestid

주어진 요청 값은 응답에 포함됩니다. 요청을 구분하기 위해 사용될 수 있습니다.

servedby

결과에 요청을 처리한 호스트명을 포함합니다.

유형: 불리언 (자세한 정보)

curtimestamp

결과의 타임스탬프를 포함합니다.

유형: 불리언 (자세한 정보)

responselanginfo

uselang 및 errorlang에 사용되는 언어를 결과에 포함합니다.

유형: 불리언 (자세한 정보)

origin

크로스 도메인 AJAX 요청 (CORS)을 사용하여 API에 접근할 때, 이것을 발신 도메인으로 설정하십시오. 모든 pre-flight 요청에 포함되어야 하며, 이에 따라 (POST 본문이 아닌) 요청 URL의 일부여야 합니다.

인증된 요청의 경우, Origin 헤더의 발신지들 중 하나와 정확히 일치해야 하므로 https://en.wikipedia.org 또는 https://meta.wikimedia.org와 같이 설정되어야 합니다. 이 매개변수가 Origin 헤더와 일치하지 않으면 403 응답이 반환됩니다. 이 매개변수가 Origin 헤더와 일치하고 발신지가 허용된 경우 Access-Control-Allow-Origin과 Access-Control-Allow-Credentials 헤더가 설정됩니다.

인증되지 않은 요청의 경우, * 값을 지정하십시오. 이를 통해 Access-Control-Allow-Origin 헤더가 설정되지만 Access-Control-Allow-Credentials는 false로 설정되어 모든 사용자 지정 데이터가 제한을 받게 됩니다.

crossorigin

크로스 도메인 AJAX 요청(CORS)을 사용하고 OAuth와 같은 크로스 사이트 요청 위조(CSRF) 공격으로부터 안전한 세션 공급자를 사용하는 경우, origin=* 대신 이 매개변수를 사용하여 요청을 인증된 상태(즉, 로그아웃되지 않은 상태)로 설정하세요. 이 매개변수는 모든 사전 요청에 포함되어야 하므로 요청 URL(POST 본문이 아님)의 일부여야 합니다.

표준 쿠키 기반 세션을 포함한 대부분의 세션 공급자는 인증된 CORS를 지원하지 않으므로 이 매개변수와 함께 사용할 수 없습니다.

유형: 불리언 (자세한 정보)

uselang

메시지 번역을 위한 언어입니다. action=query&meta=siteinfo&siprop=languages를 함께 사용하면 언어 코드의 목록이 반환됩니다. user를 지정하면 현재 사용자의 언어 환경 설정을 사용할 수 있으며, content를 지정하면 이 위키의 콘텐츠 언어를 사용합니다.

기본값: user

variant

언어의 변종입니다. 기본 언어가 변종 변환을 지원하는 경우에만 동작합니다.

errorformat

경고 및 오류 텍스트 출력을 위해 사용할 형식

plaintext: HTML 태그를 제거하고 개체가 치환된 위키텍스트입니다.
wikitext: 구문 분석이 되지 않은 위키텍스트입니다.
html: HTML
raw: 메시지 키와 매개변수입니다.
none: 텍스트 출력 없이 오류 코드만 출력합니다.
bc: 미디어위키 1.29 이전에 사용된 포맷입니다. errorlang과 errorsuselocal은 무시됩니다.

다음 값 중 하나: bc, html, none, plaintext, raw, wikitext 또는 다른 문자열: bc, html, none, plaintext, raw, wikitext

기본값: bc

errorlang

경고와 오류를 위해 사용할 언어입니다. action=query&meta=siteinfo&siprop=languages는 언어 코드의 목록을 반환합니다. content를 지정하면 이 위키의 내용 상의 언어를 사용하며, uselang을 지정하면 uselang 매개변수와 동일한 값을 사용합니다.

기본값: uselang

errorsuselocal

지정하면 오류 텍스트가 미디어위키 이름공간에서 지역적으로 정의된 메시지를 사용합니다.

유형: 불리언 (자세한 정보)

centralauthtoken

크로스 도메인 AJAX 요청 (CORS)을 사용하여 API에 접근할 때, 이것을 사용하여 현재의 SUL 사용자로 인증하십시오. 토큰을 검색하려면 CORS 요청을 하기 전에 이 위키에서 action=centralauthtoken을 사용하십시오. 각 토큰은 한 번만 사용될 것이며 60초 후에 만료됩니다. 모든 pre-flight 요청에 포함되어야 하며, 이에 따라 (POST 본문이 아닌) 요청 URI의 일부에 포함되어야 합니다.

이 위키에서 예상되는 값은 JSON 웹 토큰이며, 미디어위키 앞의 프록시 서버에서 유효성이 검사될 수 있습니다. 토큰이 만료되었거나 유효하지 않은 경우, 일반적인 API 오류와는 다른 형식의 HTTP 오류가 프록시 서버에서 발생할 수 있습니다.

예시:

메인 모듈의 도움말입니다.: api.php?action=help [연습장에서 열기]
모든 도움말을 한 페이지로 모읍니다.: api.php?action=help&recursivesubmodules=1&toc [연습장에서 열기]

크레딧

API 개발자:

Yuri Astrakhan (만든이, 선임 개발자 2006년 9월~2007년 9월)
Roan Kattouw (선임 개발자, 2007년 9월–2009년)
Victor Vasiliev
Bryan Tong Minh
Sam Reed
Brad Jorsch (선임 개발자 2013년–2020년)

당신의 의견이나 제안, 질문은 mediawiki-api@lists.wikimedia.org 로 보내주시고, 버그 보고는 https://phabricator.wikimedia.org/ 에 해주시기 바랍니다.