符合 OpenAPI
生成版本 3.0 或 3.1 中的 OpenAPI 文档。
在 PHP 源代码中记录您的 API
使用 swagger-php 可以在 PHP 源文件中编写 API 文档，这有助于使文档保持最新状态。
注释和属性支持
注解可以是 docblocks 或 PHP 8.1 属性。
1. 使用 composer 安装：
> composer require zircote/swagger-php
增加控制器，用于把代码中的注释 生成json文档数据：
class Swagger extends UserApiController
{
//生成swagger.json
public function createSwaggerJson()
{
$openapi = Generator::scan([
app_path() . 'controller',
], [
'exclude' => [
app_path() . 'controller/Swagger.php'
],
]);
$openapi->saveAs('./swagger_docs/swagger-app.json');
$this->success('生成成功');
}
//生成swagger.yaml
public function createSwaggerYaml()
{
$openapi = Generator::scan([
app_path() . 'controller',
], [
'exclude' => [
app_path() . 'controller/Swagger.php'
],
]);
header('Content-Type: application/x-yaml');
$openapi->saveAs('./swagger_docs/swagger-app.yaml');
$this->success('生成成功');
}
}好了，本文内容全部结束，感谢您的阅读，希望能帮助到您；
