1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
<?php
namespace MediaWiki\Rest\Handler;
use MediaWiki\Config\Config;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\MainConfigNames;
use MediaWiki\Rest\Handler;
use MediaWiki\Rest\LocalizedHttpException;
use MediaWiki\Rest\Module\Module;
use MediaWiki\Rest\RequestData;
use MediaWiki\Rest\ResponseFactory;
use MediaWiki\Rest\SimpleHandler;
use MediaWiki\Rest\Validator\Validator;
use Wikimedia\Message\MessageValue;
use Wikimedia\ParamValidator\ParamValidator;
/**
* Core REST API endpoint that outputs an OpenAPI spec of a set of routes.
*/
class ModuleSpecHandler extends SimpleHandler {
public const MODULE_SPEC_PATH = '/coredev/v0/specs/module/{module}';
/**
* @internal
*/
private const CONSTRUCTOR_OPTIONS = [
MainConfigNames::RightsUrl,
MainConfigNames::RightsText,
MainConfigNames::EmergencyContact,
MainConfigNames::Sitename,
];
private ServiceOptions $options;
public function __construct( Config $config ) {
$options = new ServiceOptions( self::CONSTRUCTOR_OPTIONS, $config );
$options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
$this->options = $options;
}
public function run( $moduleName, $version = '' ): array {
// TODO: implement caching, get cache key from Router.
if ( $version !== '' ) {
$moduleName .= '/' . $version;
}
if ( $moduleName === '-' ) {
// Hack that allows us to fetch a spec for the empty module prefix
$moduleName = '';
}
$module = $this->getRouter()->getModule( $moduleName );
if ( !$module ) {
throw new LocalizedHttpException(
MessageValue::new( 'rest-unknown-module' )->params( $moduleName ),
404
);
}
return [
'openapi' => '3.0.0',
'info' => $this->getInfoSpec( $module ),
'servers' => $this->getServerSpec( $module ),
'paths' => $this->getPathsSpec( $module ),
'components' => $this->getComponentsSpec( $module ),
];
}
/**
* @see https://spec.openapis.org/oas/v3.0.0#info-object
*/
private function getInfoSpec( Module $module ): array {
// TODO: Let Modules provide their name, description, version, etc
$prefix = $module->getPathPrefix();
if ( $prefix === '' ) {
$title = "Default Module";
} else {
$title = "$prefix Module";
}
return $module->getOpenApiInfo() + [
'title' => $title,
'version' => 'undefined',
'license' => $this->getLicenseSpec(),
'contact' => $this->getContactSpec(),
];
}
private function getLicenseSpec(): array {
// TODO: get terms-of-use URL, not content license.
return [
'name' => $this->options->get( MainConfigNames::RightsText ),
'url' => $this->options->get( MainConfigNames::RightsUrl ),
];
}
private function getContactSpec(): array {
return [
'email' => $this->options->get( MainConfigNames::EmergencyContact ),
];
}
private function getServerSpec( Module $module ): array {
$prefix = $module->getPathPrefix();
if ( $prefix !== '' ) {
$prefix = "/$prefix";
}
return [
[
'url' => $this->getRouter()->getRouteUrl( $prefix ),
]
];
}
private function getPathsSpec( Module $module ): array {
$specs = [];
foreach ( $module->getDefinedPaths() as $path => $methods ) {
foreach ( $methods as $mth ) {
$key = strtolower( $mth );
$mth = strtoupper( $mth );
$specs[ $path ][ $key ] = $this->getRouteSpec( $module, $path, $mth );
}
}
return $specs;
}
private function getRouteSpec( Module $module, string $path, string $method ): array {
$request = new RequestData( [ 'method' => $method ] );
$handler = $module->getHandlerForPath( $path, $request, false );
$operationSpec = $handler->getOpenApiSpec( $method );
return $operationSpec;
}
private function getComponentsSpec( Module $module ) {
$components = [];
// XXX: also collect reusable components from handler specs (but how to avoid name collisions?).
$componentsSources = [
[ 'schemas' => Validator::getParameterTypeSchemas() ],
ResponseFactory::getResponseComponents()
];
// 2D merge
foreach ( $componentsSources as $cmps ) {
foreach ( $cmps as $name => $cmp ) {
$components[$name] = array_merge( $components[$name] ?? [], $cmp );
}
}
return $components;
}
public function getParamSettings() {
return [
'module' => [
self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-module-spec-module' ),
],
'version' => [
self::PARAM_SOURCE => 'path',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_DEFAULT => '',
Handler::PARAM_DESCRIPTION => new MessageValue( 'rest-param-desc-module-spec-version' ),
],
];
}
}
|
