Skip to content

add basic openapi documentation generation #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 7 commits into
base: MOODLE_402_STABLE
Choose a base branch
from
Draft

add basic openapi documentation generation #28

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2a661e4
add basic openapi documentation generation
p8nut Jun 6, 2024
8e2fba0
update content-type to json
p8nut Jun 6, 2024
faf09cc
add error response schema
p8nut Jun 6, 2024
1169764
bump to openapi 3.1.0; add tags to each routes
p8nut Jun 6, 2024
b266db0
change openapi version to 3.0.1; validate variable availability with …
p8nut Jun 7, 2024
fd665da
update header to disable cache and cors; move request and response ty…
p8nut Jun 27, 2024
086a3ef
rollback openapi version to 3.0.0 for now; add some temporary license…
p8nut Jul 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
294 changes: 294 additions & 0 deletions openapi.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,294 @@
<?php
define('NO_DEBUG_DISPLAY', true);
define('WS_SERVER', true);

require('../../config.php');
require_once("$CFG->dirroot/webservice/restful/locallib.php");

if (!webservice_protocol_is_enabled('restful')) {
header("HTTP/1.0 403 Forbidden");
debugging('The server died because the web services or the REST protocol are not enable',
DEBUG_DEVELOPER);
die;
}

// echo yaml header
header('Content-Type: application/json');
header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
header('Pragma: no-cache');
header('Accept-Ranges: none');
// Allow cross-origin requests only for Web Services.
// This allow to receive requests done by Web Workers or webapps in different domains.
header('Access-Control-Allow-Origin: *');

$openapi = new stdClass();
$openapi->openapi = "3.0.0";
$openapi->servers = array( (object) array('url' => (string)new moodle_url('/webservice/restful/server.php')));
$openapi->info = (object) array(
'title' => 'Moodle Web Services',
'description' => 'Moodle Web Services API',
'version' => '1.0.0',
'contact' => (object) array(
"name"=> "Epitech DDOS",
"url" => "https://moodle.org/support"
),
'license' => (object) array(
'name' => 'GNU General Public License v3.0',
'url' => 'https://www.gnu.org/licenses/gpl-3.0.html'
)
);
$openapi->components = (object) array(
'schemas' => (object) array(),
'securitySchemes' => (object) array(
'MoodleAuthToken' => (object) array(
'type' => 'apiKey',
'in' => 'header',
'name' => 'Authorization'
)
),
'responses' => (object) array(
'400' => (object) array(
'description' => '4XX series status codes indicate a problem with the request. The request is missing data, malformed or unauthorised.',
'content' => array(
'application/json' => (object) array(
'schema' => (object) array(
'type' => 'object',
'properties' => (object) array(
'exception' => (object) array(
'type' => 'string',
'description' => 'The exception message'
),
'errorcode' => (object) array(
'type' => 'string',
'description' => 'The error code'
),
'message' => (object) array(
'type' => 'string',
'description' => 'The error message'
),
'debuginfo' => (object) array(
'type' => 'string',
'description' => 'The debug information'
)

)
)
)
)
)
)
);

$openapi->security = array(
array('MoodleAuthToken' => array())
);

$openapi->paths = (object) array();
$functions = $DB->get_records('external_functions', [], 'name');
foreach ($functions as $function) {
$openapi->paths->{'/'.$function->name} = moodle_webservice_function_to_openapi_path($function->name, $openapi);
}


function moodle_webservice_function_to_openapi_path($function, $openapi) {
$info = external_api::external_function_info($function);

$path = new stdClass();
$method = 'post';
$path->$method = new stdClass();
$path->$method->summary = "$info->name";
$path->$method->operationId = $info->name;
$path->$method->description = $info->description;
$path->$method->tags = array(
$info->component
);
if (isset($info->deprecated) && ($info->deprecated === true)) {
$path->$method->deprecated = true;
}
$path->$method->responses = moodle_webservice_returns_desc_to_openapi_responses($info->returns_desc, $info->name."_response", $openapi);
if (($schema = moodle_external_description_to_openapi_schema($info->parameters_desc)) !== null) {
$name = $info->name.'_parameters';
$openapi->components->schemas->$name = $schema;
$openapi->components->schemas->$name->title = $name;
$path->$method->requestBody = new stdClass();
$path->$method->requestBody->content = new stdClass();
$path->$method->requestBody->content->{'application/json'} = new stdClass();
$path->$method->requestBody->content->{'application/json'}->schema = (object) array('$ref' => "#/components/schemas/$name");
}
return $path;
}

function moodle_webservice_returns_desc_to_openapi_responses($response, $name, $openapi) {
$responses = new stdClass();

$responses->{400} = (object) array('$ref' => "#/components/responses/400");
$responses->{200} = new stdClass();
$responses->{200}->description = "this plugin will return 200 even if the call fails.";
if (($schema = moodle_external_description_to_openapi_schema($response)) !== null) {
$openapi->components->schemas->$name = $schema;
$openapi->components->schemas->$name->title = $name;
$responses->{200}->content = new stdClass();
$responses->{200}->content->{'application/json'} = new stdClass();
$responses->{200}->content->{'application/json'}->schema = (object) array('$ref' => "#/components/schemas/$name");
}
return $responses;
}

function moodle_external_description_to_openapi_schema(?external_description $value) {
if (is_null($value)) {
return null;
}
$schema = null;
if ($value instanceof external_single_structure) {
$schema = moodle_external_single_structure_to_openapi_schema($value);
} else if ($value instanceof external_multiple_structure) {
$schema = moodle_external_multiple_structure_to_openapi_schema($value);
} else if ($value instanceof external_value) {
$schema = moodle_external_value_to_openapi_schema($value);
} else {
return null;
}

if (is_null($schema)) {
return null;
}

if (isset($value->allownull) && ($value->allownull === true)) {
$schema->nullable = true;
}

return $schema;
}

function moodle_external_single_structure_to_openapi_schema(external_single_structure $value) {
$schema = new stdClass();
$schema->description = $value->desc;
$schema->type = "object";
$schema->required = [];
$schema->properties = [];

foreach ($value->keys as $key => $keyvalue) {
$item_schema = moodle_external_description_to_openapi_schema($keyvalue);
if (is_null($item_schema)) {
continue;
}
$schema->properties[$key] = $item_schema;
if (isset($keyvalue->required) && ($keyvalue->required === 1)) {
$schema->required[] = "$key";
}
}

if (empty($schema->properties)) {
return null;
}
if (empty($schema->required)) {
unset($schema->required);
}
return $schema;
}

function moodle_external_multiple_structure_to_openapi_schema(external_multiple_structure $value) {
$schema = new stdClass();
$schema->description = $value->desc;
$schema->type = "array";
$schema->items = new stdClass();
$schema->items = moodle_external_description_to_openapi_schema($value->content);
if (is_null($schema->items)) {
return null;
}
return $schema;
}

function moodle_external_value_to_openapi_schema(external_value $value) {
$schema = new stdClass();
$schema->description = $value->desc;
if (isset($value->default) && is_string($value->default) && !empty($value->default)) {
$schema->default = $value->default;
}
switch ($value->type) {
case 'int':
$schema->type = "integer";
if (isset($value->default)) {
$schema->default = (int)$value->default;
}
break;
case 'bool':
$schema->type = "boolean";
if (isset($value->default)) {
$schema->default = (bool)$value->default;
}
break;
case 'email':
$schema->type = "string";
$schema->format = "email";
break;
case 'base64':
$schema->type = "string";
$schema->format = "byte";
break;
case 'string':
$schema->type = "string";
break;
case 'alpha':
$schema->type = "string";
$schema->pattern = "^[a-zA-Z]+$";
break;
case 'alphaext':
$schema->type = "string";
$schema->pattern = "^[a-zA-Z0-9_\-]+$";
break;
case 'alphanum':
$schema->type = "string";
$schema->pattern = "^[a-zA-Z0-9]+$";
break;
case 'alphanumext':
$schema->type = "string";
$schema->pattern = "^[a-zA-Z0-9_\-]+$";
break;

case 'base64':
$schema->type = "string";
$schema->format = "byte";
break;
case 'bool':
$schema->type = "boolean";
break;

case 'email':
$schema->type = "string";
$schema->format = "email";
break;

case 'float':
$schema->type = "number";
if (isset($value->default)) {
$schema->default = (float)$value->default;
}
break;

case 'localisedfloat':
$schema->type = "number";
break;

case 'host':
$schema->oneOf= array(
(object) array(
'type' => 'string',
'format' => 'hostname'
),
(object) array(
'type' => 'string',
'format' => 'ipv4'
)
);
break;
default:
$schema->type = "string";
break;
}
return $schema;
}

echo json_encode($openapi, JSON_PRETTY_PRINT);