free-elephants/json-api-toolkit

用于构建先定义规范后JSON:API / Swagger集成API的工具


README

Build Status codecov Installs Releases

功能

  • 通过定义在OAS3 operationsIds值中快速构建FastRoute分配器
  • 使用Neomerx模式序列化Doctrine实体(解决neomerx/json-api#40问题)
  • 根据OAS3 reponseBodyrequestBody模式参考生成PHP数据传输对象,并符合json:api规范
  • 将Psr请求映射到数据传输对象
  • 使用swagger规范和用户定义的规则验证传入的Psr请求,并使用json:api错误构建Psr响应
  • 将应用程序模型映射到符合json:api结构的Psr响应

使用方法

安装

composer require free-elephants/json-api-toolkit

文档

可在/docs中找到。

索引

  1. 路由
  2. 序列化doctrine实体
  3. 从psr服务器请求生成DTO
  4. 验证

开发

所有开发环境都已容器化。您可以在没有本地安装PHP、composer的情况下使用make recipes和bin/脚本。

要使用不同的PHP版本运行测试,请更改.env中的PHP_VERSION值,并使用make build重新构建映像。