For AI agents: the complete documentation index is available at https://types-mediawiki-response.pages.dev/zh/llms.txt, the full documentation bundle is available at https://types-mediawiki-response.pages.dev/zh/llms-full.txt, and this page is available as Markdown at https://types-mediawiki-response.pages.dev/zh/api/index.md.
  • 中文
  • API 参考

    字段级页面由类型声明生成,与发布内容始终一致;每个字段的语义、弃用情况与参数约束都在 JSDoc 里,此处可查,IDE 悬停同样可见。

    响应信封与错误处理、query 结果翻页、用 QueryPage 收窄 query.pages、读日志明细、字段类型与线格式的对应关系、激活扩展包这些概念见指南;本树是字段级参考。

    Info

    API 参考由 typedoc 从类型声明自动生成,暂无中文翻译。

    Core

    MediaWiki 核心能返回的一切:响应信封(ApiEnvelope、ApiResponseWith)、共享原子类型(Flag、Timestamp 等)、每个 action= 一个响应类型(ApiQueryResponse、ApiEditResponse 等),以及 action=query 框架——ApiPage、ApiQueryResult、QueryPage 投影、各模块的续传令牌(ApiQueryContinue),以及按 log action 建模的日志明细 ApiLogEventParams。

    单模块 action= 各对应一个响应类型:

    action=响应类型
    action=acquiretempusernameApiAcquireTempUserNameResponse
    action=blockApiBlockResponse
    action=changeauthenticationdataApiChangeAuthenticationDataResponse
    action=changecontentmodelApiChangeContentModelResponse
    action=checktokenApiCheckTokenResponse
    action=clearhasmsgApiClearHasMsgResponse
    action=clientloginApiClientLoginResponse
    action=compareApiCompareResponse
    action=createaccountApiCreateAccountResponse
    action=deleteApiDeleteResponse
    action=editApiEditResponse
    action=emailuserApiEmailUserResponse
    action=expandtemplatesApiExpandTemplatesResponse
    action=filerevertApiFileRevertResponse
    action=imagerotateApiImageRotateResponse
    action=importApiImportResponse
    action=languagesearchApiLanguageSearchResponse
    action=loginApiLoginResponse
    action=logoutApiLogoutResponse
    action=managetagsApiManageTagsResponse
    action=mergehistoryApiMergeHistoryResponse
    action=moveApiMoveResponse
    action=optionsApiOptionsResponse
    action=parseApiParseResponse
    action=patrolApiPatrolResponse
    action=protectApiProtectResponse
    action=purgeApiPurgeResponse
    action=queryApiQueryResponse
    action=removeauthenticationdataApiRemoveAuthenticationDataResponse
    action=resetpasswordApiResetPasswordResponse
    action=revisiondeleteApiRevisionDeleteResponse
    action=rollbackApiRollbackResponse
    action=setnotificationtimestampApiSetNotificationTimestampResponse
    action=setpagelanguageApiSetPageLanguageResponse
    action=stasheditApiStashEditResponse
    action=tagApiTagResponse
    action=unblockApiUnblockResponse
    action=undeleteApiUndeleteResponse
    action=uploadApiUploadResponse
    action=userrightsApiUserrightsResponse
    action=validatepasswordApiValidatePasswordResponse
    action=watchApiWatchResponse

    完整 Core 参考见 Core 总览。

    扩展包

    扩展响应按需启用:每个包位于子路径 types-mediawiki-response/ext/<name>,一条 type-only import 即可激活——见按需启用扩展包。query 子模块的包把字段并入共享的 ApiPage / ApiQueryResult;扩展 action 的包导出独立响应类型,import type 直接使用。

    包扩展覆盖
    abusefiltersAbuseFilterlist=abusefilters / list=abuselog,action=abusefilter* 系列检查
    babelBabelmeta=babel
    categorytreeCategoryTreeaction=categorytree(独立类型)
    descriptionWikibase Clientprop=description
    discussiontoolsDiscussionToolsaction=discussiontools*(pageinfo、findcomment、subscriptions 等)
    echoEcho / Notificationsmeta=notifications 及相关 meta=、action=echomute、action=echocreateevent
    extractsTextExtractsprop=extracts
    flaggedrevsFlaggedRevsprop=flagged、list=unreviewedpages 等、action=review / action=stabilize
    gadgetsGadgetslist=gadgets、list=gadgetcategories
    globalblocksGlobalBlockinglist=globalblocks
    globalusageGlobalUsageprop=globalusage
    globaluserinfoCentralAuthmeta=globaluserinfo
    linterLinterlist=linterrors、meta=linterstats
    pageimagesPageImagesprop=pageimages
    pageviewsPageViewInfoprop=pageviews、list=mostviewed、meta=siteviews
    scribuntoScribuntoaction=scribunto-console(独立类型)
    spamblacklistSpamBlacklistaction=spamblacklist(独立类型)
    templatedataTemplateDataaction=templatedata(独立类型)
    thanksThanksaction=thank(独立类型)
    titleblacklistTitleBlacklistaction=titleblacklist(独立类型)
    visualeditorVisualEditoraction=visualeditor、action=visualeditoredit 等(独立类型)
    wikibaseWikibasemeta=wikibase、prop=pageterms、list=wblistentityusage