fa/breadcrumb-the-shire
1
0
Fork 1
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

feat(api-docs): extract API docs viewer into standalone module

Browse Source 
Move the Swagger UI viewer from core (pages/admin/api-docs/) into
modules/api-docs/ as a self-contained module. Create module manifest
with routes, permission, sidebar.admin_nav_item slot, asset group,
and authorization policy. Remove API docs ability from core
OperationsAuthorizationPolicy and UiCapabilityMap. Remove hardcoded
sidebar nav item — now contributed via module slot. Add
admin-automation group meta to sidebar template for module nav items.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Felix Schneider
2026-03-26 14:02:42 +01:00
parent 5c86c56dec
commit 02a7d2fe90
15 changed files with 142 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
modules/api-docs/pages/api-docs/index().php Normal file
View File

@@ -0,0 +1,11 @@
<?php
use MintyPHP\Buffer;
use MintyPHP\Module\ApiDocs\ApiDocsAuthorizationPolicy;
use MintyPHP\Support\Guard;
Guard::requireLogin();
Guard::requireAbilityOrForbidden(ApiDocsAuthorizationPolicy::ABILITY_VIEW);
Buffer::set('title', t('API docs'));
Buffer::set('style_groups', json_encode(['api-docs']));

15
modules/api-docs/pages/api-docs/index(default).phtml Normal file
View File

@@ -0,0 +1,15 @@
<?php
$breadcrumbs = [
['label' => t('Home'), 'path' => 'admin'],
['label' => t('API docs')],
];
$specUrl = lurl('admin/api-docs/spec');
require templatePath('partials/app-breadcrumb.phtml');
?>
<div class="app-swagger-container">
<div id="swagger-ui" data-spec-url="<?php e($specUrl); ?>"></div>
</div>
<script src="<?php e(assetVersion('vendor/swagger-ui/swagger-ui-bundle.js')); ?>"></script>
<script type="module" src="<?php e(assetVersion('modules/api-docs/js/pages/admin-api-docs-index.js')); ?>"></script>

29
modules/api-docs/pages/api-docs/spec().php Normal file
View File

@@ -0,0 +1,29 @@
<?php
use MintyPHP\Module\ApiDocs\ApiDocsAuthorizationPolicy;
use MintyPHP\Support\Guard;
define('MINTY_ALLOW_OUTPUT', true);
Guard::requireLogin();
Guard::requireAbilityOrForbidden(ApiDocsAuthorizationPolicy::ABILITY_VIEW);
$specPath = defined('APP_ROOT') ? APP_ROOT . '/docs/openapi.yaml' : dirname(__DIR__, 4) . '/docs/openapi.yaml';
if (!is_file($specPath)) {
http_response_code(404);
return;
}
if (!is_readable($specPath)) {
http_response_code(500);
return;
}
header('Content-Type: application/yaml; charset=utf-8');
header('X-Content-Type-Options: nosniff');
header('Cache-Control: private, max-age=60');
$bytes = @readfile($specPath);
if ($bytes === false) {
http_response_code(500);
}