chevere/schwager-html

生成 Schwager API 的文档

0.1.0 2024-05-25 20:51 UTC

This package is auto-updated.

Last update: 2024-09-25 21:33:29 UTC


README

🔔 订阅 时事通讯,不要错过任何关于 Chevere 的更新。

Chevere

Build Code size Apache-2.0 PHPStan Mutation testing badge

Quality Gate Status Maintainability Rating Reliability Rating Security Rating Coverage Technical Debt CodeFactor Codacy Badge

演示

Schwager HTML light Schwager HTML dark

这里有可以查看的 在线演示。这是从 demo/demo.php 脚本生成的。

快速开始

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

除非适用法律要求或书面同意,否则在许可证下分发的软件按“现状”提供,不提供任何明示或暗示的保证或条件。有关许可证的具体语言和权限限制,请参阅许可证。