Skip to content

Latest commit

 

History

History
329 lines (267 loc) · 7.89 KB

README2.md

File metadata and controls

329 lines (267 loc) · 7.89 KB

PHP Swagger Api Docs

基于 Hyperf 框架的 swagger 文档生成组件，支持swoole/swow驱动

优点
  • 声明参数类型完成自动注入，参数映射到PHP类，根据类和注解自动生成Swagger文档
  • 代码DTO模式，可维护性好，扩展性好
  • 支持数组(类/简单类型)，递归，嵌套
  • 支持注解数据校验
  • 支持api token
  • 支持PHP8原生注解，PHP8.1枚举
  • 支持openapi 3.0

使用须知

  • php版本 >= 8.0
  • 控制器中方法尽可能返回类,这样会更好的生成文档
  • 当返回类的结果满足不了时,可以使用 #[ApiResponse] 注解

例子

请参考example目录

安装

composer require tangwei/apidocs

使用

1. 发布配置文件

php bin/hyperf.php vendor:publish tangwei/apidocs
1.1 配置信息

config/autoload/api_docs.php

return [
    // enable false 将不会启动 swagger 服务
    'enable' => env('APP_ENV') !== 'prod',
    'format' => 'json',
    'output_dir' => BASE_PATH . '/runtime/swagger',
    'prefix_url' => env('API_DOCS_PREFIX_URL', '/swagger'),
    // 替换验证属性
    'validation_custom_attributes' => true,
    // 全局responses
    'responses' => [
        ['response' => 401, 'description' => 'Unauthorized'],
        ['response' => 500, 'description' => 'System error'],
    ],
    // swagger 的基础配置  OpenAPI 对象
    'swagger' => [
        'info' => [
            'title' => 'API DOC',
            'version' => '0.1',
            'description' => 'swagger api desc',
        ],
        'servers' => [
            [
                'url' => 'http://127.0.0.1:9501',
                'description' => 'OpenApi host',
            ],
        ],
        'components' => [
            'securitySchemes' => [
                [
                    'securityScheme' => 'Authorization',
                    'type' => 'apiKey',
                    'in' => 'header',
                    'name' => 'Authorization',
                ],
            ],
        ],
        'security' => [
            ['Authorization' => []],
        ],
        'externalDocs' => [
            'description' => 'Find out more about Swagger',
            'url' => 'https://github.com/tw2066/api-docs',
        ],
    ],
];

2. 直接启动框架(需要有http服务)

php bin/hyperf.php start

[INFO] Swagger docs url at http://0.0.0.0:9501/swagger
[INFO] TaskWorker#1 started.
[INFO] Worker#0 started.
[INFO] HTTP Server listening at 0.0.0.0:9501

看到Swagger Url显示，表示文档生成成功，访问/swagger即可以看到swagger页面

3. 使用

注解

命名空间:Hyperf\DTO\Annotation\Contracts

#[RequestBody]

  • 获取Body参数
public function add(#[RequestBody] DemoBodyRequest $request){}

#[RequestQuery]

  • 获取GET参数
public function add(#[RequestQuery] DemoQuery $request){}

#[RequestFormData]

  • 获取表单请求
public function fromData(#[RequestFormData] DemoFormData $formData){}
  • 获取文件(和表单一起使用)
#[ApiFormData(name: 'photo', format: 'binary')]
  • 获取Body参数和GET参数
public function add(#[RequestBody] DemoBodyRequest $request, #[RequestQuery] DemoQuery $query){}

#[ApiSecurity] 注解

  • 优先级: 方法 > 类 > 全局
#[ApiSecurity('Authorization')]
public function getUserInfo(DemoToken $header){}

注意: 一个方法，不能同时注入RequestBody和RequestFormData

示例

控制器

#[Controller(prefix: '/demo')]
#[Api(tags: 'demo管理', position: 1)]
class DemoController extends AbstractController
{
    #[ApiOperation(summary: '查询')]
    #[PostMapping(path: 'index')]
    public function index(#[RequestQuery] #[Valid] DemoQuery $request): Contact
    {
        $contact = new Contact();
        $contact->name = $request->name;
        var_dump($request);
        return $contact;
    }

    #[PutMapping(path: 'add')]
    #[ApiOperation(summary: '提交body数据和get参数')]
    public function add(#[RequestBody] DemoBodyRequest $request, #[RequestQuery] DemoQuery $query)
    {
        var_dump($query);
        return json_encode($request, JSON_UNESCAPED_UNICODE);
    }

    #[PostMapping(path: 'fromData')]
    #[ApiOperation(summary: '表单提交')]
    #[ApiFormData(name: 'photo', type: 'file')]
    #[ApiResponse(code: '200', description: 'success', className: Address::class, type: 'array')]
    public function fromData(#[RequestFormData] DemoFormData $formData): bool
    {
        $file = $this->request->file('photo');
        var_dump($file);
        var_dump($formData);
        return true;
    }

    #[GetMapping(path: 'find/{id}/and/{in}')]
    #[ApiOperation('查询单体记录')]
    #[ApiHeader(name: 'test')]
    public function find(int $id, float $in): array
    {
        return ['$id' => $id, '$in' => $in];
    }

}

验证器

基于框架的验证

安装hyperf框架验证器hyperf/validation, 并配置(已安装忽略)

  • 注解 Required Between Date Email Image Integer Nullable Numeric Url Validation ...
  • 校验生效

只需在控制器方法中加上 #[Valid] 注解

public function index(#[RequestQuery] #[Valid] DemoQuery $request){}
class DemoQuery
{
    #[ApiModelProperty('名称')]
    #[Required]
    #[Max(5)]
    #[In(['qq','aa'])]
    public string $name;

    #[ApiModelProperty('正则')]
    #[Str]
    #[Regex('/^.+@.+$/i')]
    #[StartsWith('aa,bb')]
    #[Max(10)]
    public string $email;

    #[ApiModelProperty('数量')]
    #[Required]
    #[Integer]
    #[Between(1,5)]
    public int $num;
}

自定义注解验证

注解的验证支持框架所有验证, 组件提供了常用的注解用于验证

  1. 使用自定义验证注解, 创建注解类继承Hyperf\DTO\Annotation\Validation\BaseValidation
  2. 重写$rule属性或getRule方法
//示例
#[Attribute(Attribute::TARGET_PROPERTY)]
class Image extends BaseValidation
{
    protected $rule = 'image';
}

验证器Validation

  1. 大家都习惯了框架的required|date|after:start_date写法
 //可以通过Validation实现
 #[Validation('required|date|after:start_date')]
  1. 需要支持数组里面是int数据情况 'intArr.*' => 'integer'的情况
    //可以通过Validation中customKey来自定义key实现
    #[Validation('integer', customKey: 'intArr.*')]
    public array $intArr;

上面写法和'intArr.*' => 'integer'效果相同

注意

数组类型的问题

PHP原生暂不支持int[]或Class[]类型, 使用示例

    /**
     * class类型映射数组.
     * @var \App\DTO\Address[]
     */
    #[ApiModelProperty('地址')]
    public array $addressArr;

    /**
     * 简单类型映射数组.
     * @var int[]
     */
    #[ApiModelProperty('int类型的数组')]
    public array $intArr;

    /**
     * 通过注解映射数组.
     */
    #[ApiModelProperty('string类型的数组')]
    #[ArrayType('string')]
    public array $stringArr;

hyperf 2.2版本报错

@required注解会提示报错,请忽略required

修改文件config/autoload/annotations.php

return [
    'scan' => [
        //...
        'ignore_annotations' => [
            //...
           'required'
        ],
    ],
];

AutoController注解

控制器中使用AutoController注解,只收集了POST方法

RPC 返回PHP对象

当框架导入 symfony/serializer (^5.0) 和 symfony/property-access (^5.0) 后，并在 dependencies.php 中配置一下映射关系

use Hyperf\DTO\Serializer\SerializerFactory;
use Hyperf\Utils\Serializer\Serializer;

return [
    Hyperf\Contract\NormalizerInterface::class => new SerializerFactory(Serializer::class),
];

Swagger界面

hMvJnQ