leankoala/leanapibundle

一个用于处理Symfony API请求的小型包

dev-master 2024-08-26 08:34 UTC

This package is auto-updated.

Last update: 2024-08-26 08:34:22 UTC


README

Leankoala LeanApiBundle 是使用Symfony作为RESTful API的基础。

组件

  • CORS 监听器 - 此组件处理强制性的CORS头。如果API应从浏览器中访问,则这些头是强制性的。
  • ApiRequest - API请求处理HTTP请求体中的参数。它还像Symfony ParamConverter一样验证和转换参数。

第一步

第一步解释了如何安装LeanApiBundle以及如何处理请求数据。

安装

LeanApiBundle可以通过composer安装。

$ composer require leankoala/leanapibundle

之后,在AppKernel.php中添加该包。

$bundles = [
    ...
    new LeankoalaLeanApiBundle(),
    ...
]

API 路由

apiRequest 使用方法

$apiRequest = new ApiRequest(
    $symfonyRequest,
    $doctrine,
    $schema
);

想法

API包已经做了很多,但我们还想让它做更多的事情。这是一个想法列表

  • 从模式数组自动生成Markdown
  • 使用@annotations注入带有正确模式的ApiRequest对象
  • 使用yml作为模式