README

简介

本包使用Symfony 序列化器

享受自动生成 Swagger API文档的魔法
MapRequestPayload 和 MapQueryString 以反序列化您的请求
通过将对象返回给控制器来自动序列化响应
提供优雅的Symfony 验证响应
一个分页工具，帮助您处理集合

ApiScout将大大帮助您开发API，无需重新发明轮子

您可以选择使用这些工具，也可以选择不使用它们，无需与ApiScout抗争。

安装

composer require api-scout/api-scout

<?php
# config/bundles.php

return [
    // ...
    ApiScout\Bridge\Symfony\Bundle\ApiScoutBundle::class => ['all' => true]
];

# config/routes.yaml
api_scout_swagger_ui:
  path: /api/docs.{_format}
  controller: api_scout.swagger_ui.action
  methods: GET
  format: html

使用

使用以下任一可用的属性方法：

<?php

namespace ApiScout\Controller;

use ApiScout\Attribute\Get;

final class GetBookController
{
    #[Get('/books')]
    public function __invoke(string $id): BookOutput
    {
        return new BookOutput(
            'PHPStan',
            'There is only one level with PHPStan. The level max.'
        );
    }
}

您的API规范现在可在以下位置获取：/api/docs

方法

OpenApi

高级

迁移到Api-Scout

贡献

欢迎提交拉取请求。对于重大更改，请先创建一个问题来讨论您想要更改的内容。

请确保根据需要更新测试。有关更多信息，请参阅贡献指南

致谢

由 Marvin Courcier 创建。

本库由 Alximy 赞助。

api-scout / api-scout

维护者

详细信息

README

简介

安装

使用

方法

OpenApi

高级

迁移到Api-Scout

贡献

致谢