Charon 是一个用于构建自文档 RESTful API 的框架。

v1.5.12 2022-09-13 13:37 UTC

README

Build Status

强化版的分形。

是什么?

Charon 是一个用于构建自文档 RESTful API 的 PHP 框架。

请访问 我们的网站 获取更多信息。

入门

虽然 Charon 可以与任何框架一起使用,但我已经创建了一个 laravel 骨架项目,以便您快速开始。

安装

composer create-project catlabinteractive/laravel-charon api

配置

请按照 https://github.com/CatLabInteractive/laravel-charon-template 上的说明进行操作

为什么?

在构建 RESTful API 时,有一些事情会反复出现

  • 实体到资源的转换
  • API 描述
  • 资源字段过滤
  • 关系及其展开
  • 过滤
  • 排序
  • 分页

Charon 通过提供一个框架来处理这些功能中的大部分,从而试图减少一些工作。

  • 而不是编写转换器,编写定义
  • 根据这些定义进行过滤和排序
  • 允许客户端选择应返回的字段
  • 在一个请求中展开关系
  • 在一个中间件中处理所有分页

文档

默认情况下,Charon 生成 Swagger 2.0 文档。可以通过实现接口来实现其他文档器。

框架

Charon 与 Laravel 工作得非常好,但该库的设计使其能够集成到其他框架中。

不需要 ORM,但它使实现某些功能(如分页和过滤)变得容易得多。

上下文选项

对于字段和展开参数:在字段前添加 * 以重复该字段(用于递归模型)。