chevere / schwager-html
生成 Schwager API 的文档
0.1.0
2024-05-25 20:51 UTC
Requires
- php: ^8.1
- chevere/action: ^1.0.0
- chevere/http: ^0.4.0
- chevere/parameter: ^1.0.0
- chevere/router: ^0.6.0
- chevere/schwager: ^0.2.0
- chevere/standard: ^1.0.0
- symfony/yaml: ^6|^7
Requires (Dev)
- phpstan/phpstan: ^1.9
- phpunit/phpunit: ^9.5
- symplify/easy-coding-standard: ^11.1
README
🔔 订阅 时事通讯,不要错过任何关于 Chevere 的更新。
演示
这里有可以查看的 在线演示。这是从 demo/demo.php 脚本生成的。
快速开始
- 使用 Composer 安装
composer require chevere/schwager-html
- 生成 HTML
use Chevere\Schwager\DocumentSchema; use Chevere\Schwager\ServerSchema; use Chevere\Schwager\Spec; use Chevere\SchwagerHTML\Html; use function Chevere\Router\router; // Load your router $routes = require 'routes.php'; $router = router($routes); // Create document $document = new DocumentSchema( api: 'schwager', name: '🐶 Schwager Petstore', version: '1.0.0' ); // Create server $testServer = new ServerSchema( url: 'demoServerUrl', description: 'This is a sample server Petstore API spec.' ); // Create spec $spec = new Spec($router, $document, $testServer); // Create html $html = new Html($spec); // Read html as string $html->__toString();
文档
文档可在 chevere.org 查找。
许可证
版权所有 2023 Rodolfo Berrios A.
Chevere 采用 Apache 许可证,版本 2.0。有关完整许可证文本,请参阅 LICENSE。
除非适用法律要求或书面同意,否则在许可证下分发的软件按“现状”提供,不提供任何明示或暗示的保证或条件。有关许可证的具体语言和权限限制,请参阅许可证。