somnambulist/api-client

一个帮助简化创建API集成的库

4.1.0 2024-03-02 18:29 UTC

README

GitHub Actions Build Status Issues License PHP Version Current Version

ApiClient库旨在帮助构建消费JSON API的客户端库。该库提供了主要资源对象和相关值对象的抽象模型。持久性请求由封装更改请求的ApiActions处理。

模型和值对象使用somnambulist/attribute-model类型转换系统。

该库在底层使用Symfony HTTP Client。

要求

  • PHP 8.1+
  • cURL
  • symfony/event-dispatcher
  • symfony/http-client
  • symfony/routing

安装

使用composer安装,或从github.com检出/拉取文件。

  • composer require somnambulist/api-client

使用方法

此库提供了一些构建块,帮助您开始消费RESTful API。通常,这用于与微服务项目一起使用,您需要编写将在其他项目中共享的客户端。

请注意:此项目对所使用的服务的类型不进行假设。包含的库提供合适的默认值,但可以被您自己的实现完全替换。

文档位于docs文件夹中,建议的阅读顺序如下

测试

使用PHPUnit 9+进行测试。通过vendor/bin/phpunit运行测试。

测试数据使用faker生成,是随机生成的。

链接