미디어위키 API 도움말

이 페이지는 自動으로 生成된 미디어위키 API 도움말 文書입니다.

說明 文書 및 例示: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

메인 모듈

狀態: 이 페이지에 보이는 모든 機能은 正常的으로 作動하지만, API는 如前히 活潑하게 開發되고 있으며, 언제든지 變更될 수 있습니다. 업데이트 公知를 받아보려면 mediawiki-api-announce 메일링 리스트 를 購讀하십시오.

잘못된 要請: API에 잘못된 要請이 電送되면 "MediaWiki-API-Error" 키가 包含된 HTTP 헤더가 電送되며 返還되는 헤더와 誤謬 코드의 값은 모두 同一한 값으로 設定됩니다. 仔細한 情報에 對해서는 API:誤謬와 警告 를 參照하십시오.

테스트하기: API 要請 테스트를 容易하게 하려면, Special:ApiSandbox 를 보십시오.

特定 變數:
action

遂行할 動作

abusefiltercheckmatch
編輯 필터가 變數 集合, 編輯, 또는 記錄된 編輯 필터 이벤트와 一致하는지 確認합니다.
abusefilterchecksyntax
編輯 필터의 構文을 檢事합니다.
abusefilterevalexpression
編輯 필터의 式을 檢事합니다.
abusefilterunblockautopromote
編輯 필터 動作으로 인해 自動 認證을 받지 못하도록 制限된 使用者의 制限을 解除합니다.
abuselogprivatedetails
惡用 記錄 項目의 非公開 細部 事項을 봅니다.
acquiretempusername
臨時 計定 生成이 活性化되고 現在 使用者가 로그아웃된 境遇 臨時 使用者의 使用者 이름을 獲得하여 現在 세션에 保管합니다. 이름이 이미 숨겨져 있으면 同一한 이름을 返還합니다.
antispoof
안티스푸프의 標準化 檢査를 使用하여 使用者名을 檢事합니다.
block
使用者를 遮斷합니다.
centralauthtoken
統合된 위키에서 認證 要請을 보내는 데 必要한 centralauthtoken을 받아옵니다.
centralnoticecdncacheupdatebanner
匿名 使用者, 要請된 배너, 그리고 言語와 關聯하여 CDN(프론트엔드) 캐시에 貯藏된 배너 콘텐츠의 새로 고침을 要請합니다
centralnoticechoicedata
指定된 프로젝트와 言語를 위한 배너 選擇에 必要한 데이터를 가져옵니다
centralnoticequerycampaign
캠페인을 위한 모든 構成 設定을 가져옵니다.
changeauthenticationdata
現在 使用者의 認證 데이터를 變更합니다.
changecontentmodel
文書의 콘텐츠 모델을 變更
checktoken
action=query&meta=tokens 의 토큰의 有效性을 確認합니다.
cirrus-config-dump
CirrusSearch 構成의 덤프입니다.
cirrus-mapping-dump
이 위키의 CirrusSearch 매핑의 덤프입니다.
cirrus-profiles-dump
이 위키의 CirrusSearch 프로파일의 덤프입니다.
cirrus-settings-dump
이 위키의 CirrusSearch 設定의 덤프입니다.
clearhasmsg
現在 使用者의 hasmsg 플래그를 비웁니다.
clientlogin
相互作用 플로우를 利用하여 위키에 로그인합니다.
compare
두 文書 間의 差異를 가져옵니다.
createaccount
새 使用者 計定을 만듭니다.
createlocalaccount
로컬 計定을 强制로 生成
cxdelete
內容 飜譯 擴張 機能을 使用하여 만든 草案 飜譯을 削除합니다.
cxsuggestionlist
提案 目錄을 管理합니다. 目錄에 提案을 追加하고 除去합니다.
cxtoken
cxserver와 認證하기 위해 JWT 토큰을 가져옵니다.
delete
文書를 削除합니다.
deleteglobalaccount
統合 使用者 計定을 削除합니다.
discussiontoolsedit
討論 文書에 메시지를 揭示합니다.
discussiontoolsfindcomment
ID 또는 이름으로 댓글을 찾습니다.
discussiontoolsgetsubscriptions
指定된 主題의 購讀 狀態를 가져옵니다.
discussiontoolssubscribe
主題에 關한 알림을 受信하기 위해 購讀(또는 購讀 解止)을 합니다.
echomarkread
現在 使用者의 알림을 읽은 것으로 標示합니다.
echomarkseen
現在 使用者가 알림을 본 것으로 標示합니다.
echomute
特定 使用者나 文書로부터 오는 알림을 끄거나 다시 켭니다.
edit
文書를 만들고 編輯합니다.
editmassmessagelist
大量 메시지 受信者 目錄을 編輯합니다.
emailuser
使用者에게 이메일을 보냅니다.
expandtemplates
위키텍스트 안에 모든 틀을 擴張합니다.
featuredfeed
알찬 글 피드를 返還합니다.
feedcontributions
使用者 寄與 피드를 返還합니다.
feedrecentchanges
最近 바뀜 피드를 返還합니다.
feedwatchlist
注視文書 目錄 피드를 返還합니다.
filerevert
파일을 以前 板으로 되돌립니다.
globalblock
使用者를 轉役 遮斷하거나 解除합니다.
globalpreferenceoverrides
現在 使用者의 轉役 環境 設定의 로컬 오버라이드를 變更합니다.
globalpreferences
現在 使用者의 統合 計定 環境設定을 變更합니다.
globaluserrights
轉役 使用者 그룹에서 使用者를 追加/除去합니다.
growthmanagementorlist
構造化된 멘토 目錄(普通 MediaWiki:GrowthMentors.json 에 貯藏됨)의 情報를 管理합니다. 이 모듈은 (自身을 追加하고 自身의 詳細 情報를 變更하기 위해) 現在 및 未來의 멘토에 依해, 그리고 (모든 使用者를 위해) 管理者에 依해 追加될 수 있습니다.
growthmentordashboardupdatedata
멘토 대시보드에서 멘티 槪要 모듈의 相當한 업데이트를 스케줄링합니다. 性能을 理由로 2時間에 한 次例의 업데이트만 스케줄링할 수 있습니다.
growthsetmenteestatus
멘티의 狀態 보기 (멘티가 멘토十 모듈을 活性化/비활성화하거나 完全히 參與를 하지 않기로 할 수 있으며 이 境遇 멘티/멘토 關係는 削除됩니다)
growthsetmentor
使用者의 멘토를 設定합니다. 變更 記錄은 公開됩니다.
growthstarmentee
現在 使用者가 指定한 멘티를 標示하거나 表示를 解除합니다 (非公開 狀態로 貯藏되며 記錄에 남지 않습니다)
help
指定된 모듈의 도움말을 表示합니다.
homepagequestionstore
홈페이지 모듈을 통해 揭示된 棲息이 있는 質問을 가져옵니다
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
管理者가 投票를 除去하거나 除去를 取消할 수 있게 합니다.
sxdelete
데이터베이스에서 草案 文壇 飜譯 및 該當 竝列 말뭉치를 削除합니다.
tag
個別 板이나 記錄 項目에서 變更 태그를 追加하거나 除去합니다.
templatedata
TemplateData 擴張 機能에 依해 貯藏된 데이터를 가져옵니다.
thank
編輯者에게 感謝 알림을 보냅니다.
titleblacklist
TitleBlacklist에 對해 文書 題目, 파일 이름, 使用者 이름을 檢事합니다.
torblock
IP 住所가 토르에 依해 遮斷되어 있는지 確認합니다.
transcodereset
'transcode-reset' 權限이 있는 使用者는 트랜스코드 作業을 初期化하고 다시 實行할 수 있습니다.
unblock
使用者를 遮斷 解除합니다.
undelete
削除된 文書의 판을 削除 取消합니다.
unlinkaccount
現在 使用者에 連結된 他社 計定을 除去합니다.
upload
파일을 업로드하거나 待機 中인 업로드의 狀態를 가져옵니다.
userrights
使用者의 그룹 權限을 變更합니다.
validatepassword
위키의 祕密番號 政策에 根幹하여 祕密番號를 確認합니다.
watch
現在 使用者의 注視目錄에서 文書를 追加하거나 除去합니다.
webapp-manifest
웹앱 매니페스트를 返還합니다.
webauthn
登錄/認證 過程 中에 서버와 클라이언트 間 通信을 하기 위한 API 모듈입니다.
wikilove
다른 使用者에게 위키사랑을 授與합니다.
bouncehandler
內部 變數입니다. 返送된 이메일을 受信한 後에 受信에 失敗한 받는 사람을 위해 메일을 處理합니다.
categorytree
內部 變數입니다. CategoryTree 擴張 機能을 위한 內部 모듈입니다.
cirrus-check-sanity
內部 變數입니다. Reports on the correctness of a range of page ids in the search index
collection
內部 變數입니다. 위키 使用者의 모음집에 다양한 動作을 遂行하기 위한 API 모듈입니다.
cspreport
內部 變數입니다. 브라우저가 콘텐츠 保安 政策의 違反을 報告하기 위해 使用합니다. 이 모듈은 SCP를 遵守하는 웹 브라우저에 依해 自動으로 使用될 때를 除外하고는 使用해서는 안 됩니다.
cxcheckunreviewed
內部 變數입니다. 現在 使用者에 對해 美檢討된 飜譯이 最近 揭示되었는지 確認합니다.
cxpublish
內部 變數입니다. 內容 飜譯 擴張 機能을 使用해 만든 文書를 貯藏합니다.
cxpublishsection
內部 變數입니다. 內容 飜譯 擴張 機能의 文壇 飜譯 機能을 使用하여 만든 文段을 貯藏합니다.
cxsave
內部 變數입니다. 이 모듈은 帶域幅을 貯藏하고 竝列 코퍼스를 蒐集하기 위해 文壇別로 草案 飜譯을 貯藏할 수 있습니다.
cxsplit
內部 變數입니다. 주어진 文書 飜譯의 飜譯된 모든 文壇에 對해 文壇 飜譯을 生成하고 데이터베이스에 貯藏합니다
discussiontoolscompare
內部 變數입니다. 두 페이지 판 사이의 意見 變更 內容에 關한 情報를 가져옵니다.
discussiontoolspageinfo
內部 變數입니다. 討論 道具 初期化에 必要한 메타데이터를 返還합니다.
discussiontoolspreview
內部 變數입니다. 討論 文書의 메시지를 미리 봅니다.
echopushsubscriptions
內部 變數입니다. 現在 使用者의 푸시 購讀을 管理합니다.
editcheckreferenceurl
內部 變數입니다. Check the status of a URL for use as a reference.
fancycaptchareload
內部 變數입니다. 새 FancyCaptcha를 가져옵니다.
growthinvalidateimagerecommendation
內部 變數입니다. 이미지 勸告 作業을 無效化합니다
growthinvalidatepersonalizedpraisesuggestion
內部 變數입니다. 멘토 대시보드 內 個人化된 稱讚 모듈에서 稱讚할만한 멘티 提案을 無效化합니다
helppanelquestionposter
內部 變數입니다. 現在 使用者의 도움말 패널을 통해 揭示된 質問을 管理합니다.
jsondata
內部 變數입니다. 地域化된 JSON 데이터를 檢索합니다.
oathvalidate
內部 變數입니다. 2要素 引證 (OATH) 토큰을 檢事합니다.
parser-migration
內部 變數입니다. 서로 다른 2個의 Tidy 構成을 使用하여 文書의 構文을 分析합니다.
readinglists
內部 變數입니다. 읽기 目錄 쓰기 命令입니다.
sanitize-mapdata
內部 變數입니다. Kartographer 擴張을 위한 데이터 有效性 確認을 遂行합니다
scribunto-console
內部 變數입니다. Scribunto 콘솔에서 XHR 要請을 서비스하기 위한 內部 모듈입니다.
securepollauth
內部 變數입니다. 投票에 對한 接近 權限을 附與하기 前에 遠隔 위키가 使用者를 認證할 수 있도록 합니다.
stashedit
內部 變數입니다. 共有된 캐시에서 編輯을 準備합니다.
sxsave
內部 變數입니다. 草案 文壇 飜譯을 貯藏하고 竝列 말뭉치들을 保管합니다
timedtext
內部 變數입니다. <track> 要素들의 使用에 對한 타임드 텍스트 內容을 提供합니다
ulslocalization
內部 變數입니다. 주어진 言語로 ULS의 地域化를 가져옵니다.
ulssetlang
內部 變數입니다. 使用者의 選好하는 인터페이스 言語를 업데이트합니다.
visualeditor
內部 變數입니다. Parsoid 서비스에서 文書를 위해 HTML5를 返還합니다.
visualeditoredit
內部 變數입니다. HTML5 페이지를 미디어위키로 貯藏합니다. (Parsoid 서비스를 통해 위키텍스트로 變換)
wikimediaeventsblockededit
內部 變數입니다. 遮斷된 編輯 試圖의 記錄 情報입니다
다음 값 中 하나: abusefiltercheckmatch , abusefilterchecksyntax , abusefilterevalexpression , abusefilterunblockautopromote , abuselogprivatedetails , acquiretempusername , antispoof , block , centralauthtoken , centralnoticecdncacheupdatebanner , centralnoticechoicedata , centralnoticequerycampaign , changeauthenticationdata , changecontentmodel , checktoken , cirrus-config-dump , cirrus-mapping-dump , cirrus-profiles-dump , cirrus-settings-dump , clearhasmsg , clientlogin , compare , createaccount , createlocalaccount , cxdelete , cxsuggestionlist , cxtoken , delete , deleteglobalaccount , discussiontoolsedit , discussiontoolsfindcomment , discussiontoolsgetsubscriptions , discussiontoolssubscribe , echomarkread , echomarkseen , echomute , edit , editmassmessagelist , emailuser , expandtemplates , featuredfeed , feedcontributions , feedrecentchanges , feedwatchlist , filerevert , globalblock , globalpreferenceoverrides , globalpreferences , globaluserrights , growthmanagementorlist , growthmentordashboardupdatedata , growthsetmenteestatus , growthsetmentor , growthstarmentee , help , homepagequestionstore , 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 , sxdelete , tag , templatedata , thank , titleblacklist , torblock , transcodereset , unblock , undelete , unlinkaccount , upload , userrights , validatepassword , watch , webapp-manifest , webauthn , wikilove , bouncehandler , categorytree , cirrus-check-sanity , collection , cspreport , cxcheckunreviewed , cxpublish , cxpublishsection , cxsave , cxsplit , discussiontoolscompare , discussiontoolspageinfo , discussiontoolspreview , echopushsubscriptions , editcheckreferenceurl , fancycaptchareload , growthinvalidateimagerecommendation , growthinvalidatepersonalizedpraisesuggestion , helppanelquestionposter , jsondata , oathvalidate , parser-migration , readinglists , sanitize-mapdata , scribunto-console , securepollauth , stashedit , sxsave , timedtext , ulslocalization , ulssetlang , visualeditor , visualeditoredit , wikimediaeventsblockededit 또는 다른 文字列 : abusefiltercheckmatch , abusefilterchecksyntax , abusefilterevalexpression , abusefilterunblockautopromote , abuselogprivatedetails , acquiretempusername , antispoof , block , centralauthtoken , centralnoticecdncacheupdatebanner , centralnoticechoicedata , centralnoticequerycampaign , changeauthenticationdata , changecontentmodel , checktoken , cirrus-config-dump , cirrus-mapping-dump , cirrus-profiles-dump , cirrus-settings-dump , clearhasmsg , clientlogin , compare , createaccount , createlocalaccount , cxdelete , cxsuggestionlist , cxtoken , delete , deleteglobalaccount , discussiontoolsedit , discussiontoolsfindcomment , discussiontoolsgetsubscriptions , discussiontoolssubscribe , echomarkread , echomarkseen , echomute , edit , editmassmessagelist , emailuser , expandtemplates , featuredfeed , feedcontributions , feedrecentchanges , feedwatchlist , filerevert , globalblock , globalpreferenceoverrides , globalpreferences , globaluserrights , growthmanagementorlist , growthmentordashboardupdatedata , growthsetmenteestatus , growthsetmentor , growthstarmentee , help , homepagequestionstore , 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 , sxdelete , tag , templatedata , thank , titleblacklist , torblock , transcodereset , unblock , undelete , unlinkaccount , upload , userrights , validatepassword , watch , webapp-manifest , webauthn , wikilove , bouncehandler , categorytree , cirrus-check-sanity , collection , cspreport , cxcheckunreviewed , cxpublish , cxpublishsection , cxsave , cxsplit , discussiontoolscompare , discussiontoolspageinfo , discussiontoolspreview , echopushsubscriptions , editcheckreferenceurl , fancycaptchareload , growthinvalidateimagerecommendation , growthinvalidatepersonalizedpraisesuggestion , helppanelquestionposter , jsondata , oathvalidate , parser-migration , readinglists , sanitize-mapdata , scribunto-console , securepollauth , stashedit , sxsave , timedtext , ulslocalization , ulssetlang , visualeditor , visualeditoredit , wikimediaeventsblockededit
基本값: help
format

出力값의 形式.

json
데이터를 JSON 形式으로 出力합니다.
jsonfm
데이터를 JSON 포맷으로 出力합니다. (HTML의 可讀性 增加)
none
아무 것도 出力하지 않습니다.
php
데이터를 直列化된 PHP 포맷으로 出力합니다.
phpfm
데이터를 PHP 포맷(HTML의 可讀性 增加)으로 出力합니다.
rawfm
디버깅 要素를 包含하여 데이터를 JSON 形式으로 出力합니다. (HTML의 可讀性 增加)
xml
데이터를 XML 形式으로 出力합니다.
xmlfm
데이터를 XML 포맷(可讀性 높은 HTML 方式)으로 出力합니다.
다음 값 中 하나: json , jsonfm , none , php , phpfm , rawfm , xml , xmlfm 또는 다른 文字列 : json , jsonfm , none , php , phpfm , 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 本文이 아닌) 要請 URI의 一部與野 합니다.

引證된 要請의 境遇, 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 로 設定되어 모든 使用者 指定 데이터가 制限을 받게 됩니다.

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

警告와 誤謬를 위해 使用할 言語입니다. siprop=languages 가 包含된 action=query&meta=siteinfo 는 言語 코드의 目錄을 返還하고, content 를 指定하면 이 위키의 內容 上의 言語를 使用하며, uselang 을 指定하면 uselang 變數와 同一한 값을 使用합니다.

基本값: uselang
errorsuselocal

指定하면 誤謬 텍스트가 미디어위키 이름空間에서 地域的으로 定義된 메시지를 使用합니다.

類型: 不利言 ( 仔細한 情報 )
centralauthtoken

크로스 도메인 AJAX 要請 (CORS)을 使用하여 API에 接近할 때, 이것을 使用하여 現在의 SUL 使用者로 認證하십시오. 토큰을 檢索하려면 CORS 要請을 하기 前에 이 위키에서 action=centralauthtoken 을 使用하십시오. 各 토큰은 한 番만 使用될 것이며 10秒 後에 滿了됩니다. 모든 pre-flight 要請에 包含되어야 하며, 이에 따라 (POST 本文이 아닌) 要請 URI의 一部에 包含되어야 합니다.

例示:
메인 모듈의 도움말입니다.
api.php?action=help [演習場에서 열기]
모든 도움말을 한 페이지로 모읍니다.
api.php?action=help&recursivesubmodules=1 [演習場에서 열기]
權限:
writeapi
쓰기 API 使用
다음 그룹에 扶餘됨: all, user, bot
apihighlimits
API 쿼리에서 더 높은 制限 使用 (느린 쿼리: 500, 빠른 쿼리: 5000) 느린 쿼리에 對한 制限은 多重값 媒介變數에도 適用됩니다.
다음 그룹에 扶餘됨: bot, sysop

데이터 類型

미디어위키의 入力은 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 - 15 T 14 : 56 : 00 Z . 또, 文字列 now 를 使用하여 現在 타임스탬프를 指定할 수 있습니다.

틀 變數

틀 變數는 다른 一部 變數의 個別 값에 對한 API 모듈에 값이 必要한 境遇를 支援합니다. 이를테면 과일을 要請하는 API 모듈이 있다면 fruits 變數를 使用하여 要請할 과일을 指定할 수 있으며 틀 變數 {fruit}-quantity 를 使用하여 要請할 과일의 數를 指定할 수 있습니다. 沙果 1個, 바나나 5個, 딸기 20個를 願하는 API 클라이언트는 fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20 와 같은 要請을 遂行할 수 있습니다.

크레딧

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/ 에 해주시기 바랍니다.