Template:ApiEx/en

{{documentation|content=

Use this template on API documentation pages to format an example API request.

Note as an alternative, {{tl|Api help}} transcludes localized API documentation generated from source code which normally has API examples in it.

User:SPage (WMF)/ApiEx utility creates a {{tl|ApiEx}} template invocation if you paste an api.php URL into it.

Parameters

 * desc - API request description
 * lang - two-letter code for the wiki language. 'en' by default.
 * site - full URL of site to use in example (e.g., www.mediawiki.org). Overrides lang parameter.
 * p1-p9 - parameter groups, each containing either one param=value pair or multiple pairs each separated by an ampersand (&), e.g. p3=param=value&paramB=valueBbbb
 * result - the result of the query execution. Add the template, preview, click the api.php link, and copy and paste the API response into the template as | result=
 * post - a "list" of ApiEx/Post objects, to generate a post table
 * collapse - set to "no" to stop "result" and "post" sections from being collapsed with Collapse top/Collapse bottom
 * apisandbox - whether to show a "[try in ApiSandbox]" link that loads the example API query parameters into Special:ApiSandbox. Default is 1, add | apisandbox=0 to not show this link.

Example
}}