docler-labs/api-client-base

SDK 生成器 - API 客户端基础

3.0.2 2020-09-07 12:37 UTC

README

此库为由 api-client-generator 生成的客户端提供基础类和接口。

Latest Stable Version License Build Status Coverage Status

描述

生成的客户端的基础类包括

  • ClientFactory - 负责创建具有所有必要依赖项的客户端对象。
  • Client - 主要类,包含根据规范发送 API 请求所需的所有方法。
  • Request - 封装传入的请求参数。
  • RequestMapper - 将请求参数转换为适合基础 Guzzle 客户端的格式。
  • ResponseHandler - 根据返回的响应状态码决定适当的响应(错误状态码上的特定异常)。
  • ResponseMapperRegistry - 简单的响应映射器容器。
  • ResponseMapper - 将原始响应映射到易于使用的模式对象。
  • Schema - 客户端范围内的实体对象(例如 Post)。

此基础客户端存储库提供客户端结构的静态、可重用部分:RequestMapper、ResponseHandler、异常等。

开发

设置

composer install

测试

vendor/bin/phpunit

test-reports 目录中查看测试报告。

贡献

创建分支并打开 PR。

此项目的所有重大更改均记录在 CHANGELOG.md 文件中,必须维护。

格式基于 Keep a Changelog,此项目遵循 语义版本化