diegoborgs/natural-swagger-php

为您的 PHP 应用程序渲染 Swagger UI

维护者

详细信息

github.com/eudiegoborgs/natural-swagger-php

源代码

问题

安装数: 6,606

依赖项: 0

建议者: 0

安全: 0

星标: 19

关注者: 2

分支: 1

开放问题: 3

1.0.4 2022-01-07 18:22 UTC

Requires

Requires (Dev)

MIT ca52fc3230d58716d1369c68e5f5bfbfd6e1d7c4

  • Diego Borges <ferreirabdiego.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-10 18:44:09 UTC

README

Build Status Scrutinizer Code Quality Code Intelligence Status Total Downloads Latest Stable Version

自然 Swagger 允许您为您的 API 生成良好的文档。此库基于 zircote/swagger-php 和 swagger-ui。

此库为您的系统提供一个基于 Swagger UI 的界面

如何使用

使用 composer 安装

composer require diegoborgs/natural-swagger-php

将其添加到您的代码中

use Diegoborgs\NaturalSwaggerPhp\OpenApiRenderFactory;
use Diegoborgs\NaturalSwaggerPhp\Renders\RenderOpenApi;

$render = OpenApiRenderFactory::get();
$render->render(RenderOpenApi::HTML,  ['base_path' => '/path/to/annotations']);

贡献

将项目分叉并发送您的 PR。

运行测试

安装 Composer 依赖项

git clone https://github.com/eudiegoborgs/natural-swagger-php.git
cd natural-swagger-php
docker-compose run --rm composer update 
// or
composer update

然后运行测试套件

docker-compose run --rm composer test 
// or
composer test

许可证

此捆绑包在 MIT 许可下发布。