chevere/schwager-html

Generates documentation for Schwager API

0.1.0 2024-05-25 20:51 UTC

This package is auto-updated.

Last update: 2024-05-25 20:53:31 UTC


README

🔔 Subscribe to the newsletter to don't miss any update regarding 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

Demo

Schwager HTML light Schwager HTML dark

There's an online demo you can checkout. This is generated from the script at demo/demo.php

Quick start

composer require chevere/schwager-html
  • Generate 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();

Documentation

Documentation is available at chevere.org.

License

Copyright 2023 Rodolfo Berrios A.

Chevere is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.