View source for Manual:$wgVirtualRestConfig/ru

<languages />
{{SettingSummary
|name=VirtualRestConfig
|version_min=1.25.0
|sha_introduced=b13bd0996cbd0b179d869dc25bd22c17a1633995
|change_introduced=193826
|section=Miscellaneous settings
|range=(<span lang="en" dir="ltr" class="mw-content-ltr">array</span>)
|default=''<span lang="en" dir="ltr" class="mw-content-ltr">See below</span>''
|summary=<span lang="en" dir="ltr" class="mw-content-ltr">REST services configuration</span>
}}
<div lang="en" dir="ltr" class="mw-content-ltr">
== Details ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Register REST services in the subarray <code>modules</code>, and change the default values in the subarray <code>global</code>.
</div>

<span lang="en" dir="ltr" class="mw-content-ltr">The main example is [[Parsoid]], which should be configured using this parameter since MediaWiki 1.25 (see also {{ll|Extension:VisualEditor}}).</span>
<span lang="en" dir="ltr" class="mw-content-ltr">When upgrading from MediaWiki 1.25 to 1.26, the <syntaxhighlight lang="php" inline>'prefix'</syntaxhighlight> value must be renamed <syntaxhighlight lang="php" inline>'domain'</syntaxhighlight> (the latter can be added with the same value as the former for a smooth transition).</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
[[RESTBase]] can also be registered in this parameter.
</div>

{{anchor|Default value}}
<div lang="en" dir="ltr" class="mw-content-ltr">
== Default value ==
</div>
{{MW 1.28|+}}{{-}}
<syntaxhighlight lang="php">
$wgVirtualRestConfig = [
	'paths' => [],
	'modules' => [],
	'global' => [
		# Timeout in seconds
		'timeout' => 360,
		# 'domain' is set to $wgCanonicalServer in Setup.php
		'forwardCookies' => false,
		'HTTPProxy' => null
	]
];
</syntaxhighlight>

{{MW version|version=1.26|version2=1.27}}{{-}}
<syntaxhighlight lang="php">
$wgVirtualRestConfig = [
	'modules' => [],
	'global' => [
		# Timeout in seconds
		'timeout' => 360,
		# 'domain' is set to $wgCanonicalServer in Setup.php
		'forwardCookies' => false,
		'HTTPProxy' => null
	]
];
</syntaxhighlight>

{{MW 1.25}}{{-}}
<syntaxhighlight lang="php">
$wgVirtualRestConfig = array(
	'modules' => array(),
	'global' => array(
		# Timeout in seconds
		'timeout' => 360,
		'forwardCookies' => false,
		'HTTPProxy' => null
	)
);
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Parsoid ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
These are the default values when Parsoid is registered as a REST service, used when some keys are not defined.
</div>

<syntaxhighlight lang="php">
$wgVirtualRestConfig['modules']['parsoid'] = [
	// URL to the Parsoid instance - use port 8142 if you use the Debian package - the parameter 'URL' was first used but is now deprecated (string)
	'url' => 'http://localhost:8000/',
	// Parsoid "domain" (string, optional) - MediaWiki >= 1.26
	'domain' => 'localhost',
	// Parsoid "prefix" (string, optional) - deprecated since MediaWiki 1.26, use 'domain'
	'prefix' => 'localhost',
	// Forward cookies in the case of private wikis (string or false, optional)
	'forwardCookies' => false,
	// request timeout in seconds (integer or null, optional)
	'timeout' => null,
	// Parsoid HTTP proxy (string or null, optional)
	'HTTPProxy' => null,
	// whether to parse URL as if they were meant for RESTBase (boolean or null, optional)
	'restbaseCompat' => null,
];
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== RESTBase ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
These are the default values when a RESTBase service is registered, used when some keys are not defined.
</div>

<syntaxhighlight lang="php">
$wgVirtualRestConfig['modules']['restbase'] = [
	// RESTBase server URL (string)
	'url' => 'http://localhost:7231/',
	// Wiki domain to use (string)
	'domain' => 'localhost',
	// request timeout in seconds (integer or null, optional)
	'timeout' => 100,
	// cookies to forward to RESTBase/Parsoid (string or false, optional)
	'forwardCookies' => false,
	// HTTP proxy to use (string or null, optional)
	'HTTPProxy' => null,
	// whether to parse URL as if they were meant for Parsoid (boolean, optional)
	'parsoidCompat' => false,
	// whether to append the domain to the url
	'fixedUrl' => false,
];
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Proxying ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
To use a remote RESTBase installation (e.g. for testing an extension without having to install the service), you can use a setting like this:
</div>

<syntaxhighlight lang="php">
foreach ( $wgVirtualRestConfig['modules'] as &$module ) {
        $module['url'] = 'https://en.wikipedia.org/api/rest_v1/';
        $module['forwardCookies'] = false;
}
$wgVirtualRestConfig['modules']['restbase']['fixedUrl'] = true;
</syntaxhighlight>

<span id="See_also"></span>
== См. также ==
* {{ll|Parsoid}}
* {{ll|Extension:VisualEditor}}
* {{ll|RESTBase}}