baoziyoo/hyperf-api-doc

A swagger library for Hyperf.

Maintainers

Details

github.com/baoziyo/hyperf-api-doc

Source

Installs: 1 090

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 16

v1.1.5 2024-11-26 08:55 UTC

Requires

Requires (Dev)

MIT ac4acdad5f3a1d777119619702c88fd66b8745f4

  • TangWei <tw2066.woop@163.com>
  • ogg <baoziyoo.woop@gmail.com>

phpdocsswaggerhyperfhyperf swagger

This package is auto-updated.

Last update: 2025-02-26 09:32:14 UTC

README

介绍

基于 tw2066/dto tw2066/api-docs 框架改进而来，特别鸣谢tw2066/dto给的灵感

运行环境

  • php >= 8.2
  • hyperf >= 3.0

安装

composer require baoziyoo/hyperf-api-doc
php bin/hyperf.php vendor:publish baoziyoo/hyperf-api-doc

使用

例子

use Baoziyoo\Hyperf\ApiDocs\Annotation\Api;
use Baoziyoo\Hyperf\ApiDocs\Annotation\ApiHeader;
use Baoziyoo\Hyperf\ApiDocs\Annotation\ApiOperation;

#[Api(tags: 'demo管理')]
#[ApiHeader('token')]
#[ApiHeader('tokenType')]
class DemoController extends AbstractController
{
    #[ApiOperation('登陆')]
    public function index(#[RequestQuery] DemoQuery $request): Contact
    {
        $contact = new Contact();
        $contact->name = $request->name;
        var_dump($request);
        return $contact;
    }

    #[ApiOperation('更新token')]
    public function add(#[RequestBody] DemoBodyRequest $request, #[RequestQuery] DemoQuery $query)
    {
        var_dump($query);
        return json_encode($request, JSON_UNESCAPED_UNICODE);
    }

    public function fromData(#[RequestFormData] DemoFormData $formData): bool
    {
        $file = $this->request->file('photo');
        var_dump($file);
        var_dump($formData);
        return true;
    }
}