跳转到内容

模板:ApiParam/zh

来自天灾之下:危险连接资料站
Hyucen​(留言 | 贡献)2025年12月16日 (二) 16:39的版本 (导入1个版本)
(差异) ←上一版本 | 最后版本 (差异) | 下一版本→ (差异)


模板文档
考虑用Special:ApiHelp嵌入(T89318)替换此模板的调用,因为填充此模板会冗余地重复源代码中的API参数文档。

用法

此模板可用于记载API参数。 其目的是协调所有API页面中模板参数的外观。

{{ApiParam
|name=
|description=
|required=
|maxallowed=
|maxallowedbot=
|type=
|values=
|default=
|version=
|deprecated=
|removed=
}}
ApiParam参数
参数名称 描述
name (或第一个匿名参数) 参数名称(必需)。
description (或第二个匿名参数) 参数的描述。
required 如果参数是必需的,则指定一个值。 必需的参数名称将加粗。
maxallowed 对于管道分隔值或数值数量,为允许的最大值。
maxallowedbot 同上,用于机器人。 如果maxallowed的值为50或500,则默认值分别为500或5000。
type 参数的数据类型。
values 参数的可能值的列表。
default 参数的默认值。
version 参数被引入的版本。 仅使用普通的MediaWiki版本号。
deprecated 参数被弃用的版本。 仅使用普通的MediaWiki版本号。
removed 参数被移除的版本。 仅使用普通的MediaWiki版本号。

示例

*{{ApiParam|rcid|要从中添加或删除标记的一个或多个最近更改的ID。|maxallowed=50}}
  • <translate> <tvar name=1>rcid</tvar>:</translate> 要从中添加或删除标记的一个或多个最近更改的ID。 <translate> No more than <tvar name=1>50</tvar> (<tvar name=2>500</tvar> for bots) allowed.</translate>
*{{ApiParam|siprop|要获得哪些属性|default=general}}
**{{ApiParam|general|通用网站信息}}
***{{ApiParam|articlepath|{{ll|Manual:$wgArticlePath|$wgArticlePath}}|version=1.15}}
  • <translate> <tvar name=1>siprop</tvar>:</translate> 要获得哪些属性 (<translate> Default:</translate> general)
    • <translate> <tvar name=1>general</tvar>:</translate> 通用网站信息
      • <translate> <tvar name=1>articlepath</tvar>:</translate> $wgArticlePath 1.15+

参见