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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
|
<?php
namespace dokuwiki\Remote;
use dokuwiki\Remote\OpenApiDoc\DocBlockClass;
use dokuwiki\Remote\OpenApiDoc\Type;
use dokuwiki\Utf8\PhpString;
class OpenAPIGenerator
{
protected $api;
protected $documentation = [];
public function __construct()
{
$this->api = new Api();
$this->documentation['openapi'] = '3.1.0';
$this->documentation['info'] = [
'title' => 'DokuWiki API',
'description' => 'The DokuWiki API OpenAPI specification',
'version' => ((string)ApiCore::API_VERSION),
];
}
public function generate()
{
$this->addServers();
$this->addSecurity();
$this->addMethods();
return json_encode($this->documentation, JSON_PRETTY_PRINT);
}
protected function addServers()
{
$this->documentation['servers'] = [
[
'url' => DOKU_URL . 'lib/exe/jsonrpc.php',
],
];
}
protected function addSecurity()
{
$this->documentation['components']['securitySchemes'] = [
'basicAuth' => [
'type' => 'http',
'scheme' => 'basic',
],
'jwt' => [
'type' => 'http',
'scheme' => 'bearer',
'bearerFormat' => 'JWT',
]
];
$this->documentation['security'] = [
[
'basicAuth' => [],
],
[
'jwt' => [],
],
];
}
protected function addMethods()
{
$methods = $this->api->getMethods();
$this->documentation['paths'] = [];
foreach ($methods as $method => $call) {
$this->documentation['paths']['/' . $method] = [
'post' => $this->getMethodDefinition($method, $call),
];
}
}
protected function getMethodDefinition(string $method, ApiCall $call)
{
$description = $call->getDescription();
$links = $call->getDocs()->getTag('link');
if ($links) {
$description .= "\n\n**See also:**";
foreach ($links as $link) {
$description .= "\n\n* " . $this->generateLink($link);
}
}
$retType = $call->getReturn()['type'];
$result = array_merge(
[
'description' => $call->getReturn()['description'],
'examples' => [$this->generateExample('result', $retType->getOpenApiType())],
],
$this->typeToSchema($retType)
);
$definition = [
'operationId' => $method,
'summary' => $call->getSummary(),
'description' => $description,
'tags' => [PhpString::ucwords($call->getCategory())],
'requestBody' => [
'required' => true,
'content' => [
'application/json' => $this->getMethodArguments($call->getArgs()),
]
],
'responses' => [
200 => [
'description' => 'Result',
'content' => [
'application/json' => [
'schema' => [
'type' => 'object',
'properties' => [
'result' => $result,
'error' => [
'type' => 'object',
'description' => 'Error object in case of an error',
'properties' => [
'code' => [
'type' => 'integer',
'description' => 'The error code',
'examples' => [0],
],
'message' => [
'type' => 'string',
'description' => 'The error message',
'examples' => ['Success'],
],
],
],
],
],
],
],
],
]
];
if ($call->isPublic()) {
$definition['security'] = [
new \stdClass(),
];
$definition['description'] = 'This method is public and does not require authentication. ' .
"\n\n" . $definition['description'];
}
if ($call->getDocs()->getTag('deprecated')) {
$definition['deprecated'] = true;
$definition['description'] = '**This method is deprecated.** ' . $call->getDocs()->getTag('deprecated')[0] .
"\n\n" . $definition['description'];
}
return $definition;
}
protected function getMethodArguments($args)
{
if (!$args) {
// even if no arguments are needed, we need to define a body
// this is to ensure the openapi spec knows that a application/json header is needed
return ['schema' => ['type' => 'null']];
}
$props = [];
$reqs = [];
$schema = [
'schema' => [
'type' => 'object',
'required' => &$reqs,
'properties' => &$props
]
];
foreach ($args as $name => $info) {
$example = $this->generateExample($name, $info['type']->getOpenApiType());
$description = $info['description'];
if ($info['optional'] && isset($info['default'])) {
$description .= ' [_default: `' . json_encode($info['default']) . '`_]';
}
$props[$name] = array_merge(
[
'description' => $description,
'examples' => [$example],
],
$this->typeToSchema($info['type'])
);
if (!$info['optional']) $reqs[] = $name;
}
return $schema;
}
protected function generateExample($name, $type)
{
switch ($type) {
case 'integer':
if ($name === 'rev') return 0;
if ($name === 'revision') return 0;
if ($name === 'timestamp') return time() - 60 * 24 * 30 * 2;
return 42;
case 'boolean':
return true;
case 'string':
if ($name === 'page') return 'playground:playground';
if ($name === 'media') return 'wiki:dokuwiki-128.png';
return 'some-' . $name;
case 'array':
return ['some-' . $name, 'other-' . $name];
default:
return new \stdClass();
}
}
/**
* Generates a markdown link from a dokuwiki.org URL
*
* @param $url
* @return mixed|string
*/
protected function generateLink($url)
{
if (preg_match('/^https?:\/\/(www\.)?dokuwiki\.org\/(.+)$/', $url, $match)) {
$name = $match[2];
$name = str_replace(['_', '#', ':'], [' ', ' ', ' '], $name);
$name = PhpString::ucwords($name);
return "[$name]($url)";
} else {
return $url;
}
}
/**
* Generate the OpenAPI schema for the given type
*
* @param Type $type
* @return array
* @todo add example generation here
*/
public function typeToSchema(Type $type)
{
$schema = [
'type' => $type->getOpenApiType(),
];
// if a sub type is known, define the items
if ($schema['type'] === 'array' && $type->getSubType()) {
$schema['items'] = $this->typeToSchema($type->getSubType());
}
// if this is an object, define the properties
if ($schema['type'] === 'object') {
try {
$baseType = $type->getBaseType();
$doc = new DocBlockClass(new \ReflectionClass($baseType));
$schema['properties'] = [];
foreach ($doc->getPropertyDocs() as $property => $propertyDoc) {
$schema['properties'][$property] = array_merge(
[
'description' => $propertyDoc->getSummary(),
],
$this->typeToSchema($propertyDoc->getType())
);
}
} catch (\ReflectionException $e) {
// The class is not available, so we cannot generate a schema
}
}
return $schema;
}
}
|
