{"id":29167259,"url":"https://github.com/andy87/sdk-php-client","last_synced_at":"2025-11-09T16:04:53.518Z","repository":{"id":298327957,"uuid":"999560400","full_name":"andy87/sdk-php-client","owner":"andy87","description":"Базовый SKD для создания клиентов которые обращаются к API","archived":false,"fork":false,"pushed_at":"2025-06-21T07:41:40.000Z","size":48,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-21T08:29:55.389Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andy87.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-10T12:44:43.000Z","updated_at":"2025-06-21T07:41:43.000Z","dependencies_parsed_at":"2025-06-10T15:21:59.958Z","dependency_job_id":"04ad1807-5088-4198-8b77-ee399660622e","html_url":"https://github.com/andy87/sdk-php-client","commit_stats":null,"previous_names":["andy87/sdk-php-client"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/andy87/sdk-php-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andy87%2Fsdk-php-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andy87%2Fsdk-php-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andy87%2Fsdk-php-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andy87%2Fsdk-php-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andy87","download_url":"https://codeload.github.com/andy87/sdk-php-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andy87%2Fsdk-php-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262933327,"owners_count":23386785,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-01T09:09:09.908Z","updated_at":"2025-11-09T16:04:53.395Z","avatar_url":"https://github.com/andy87.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SDK Client Core\n\nУниверсальное PHP SDK-ядро для создания API-клиентов, с расширяемой архитектурой, поддержкой авторизации, моков и валидации.\nСделано для использования как основа под конкретные клиенты для работы с API.\n\n---\n\n## ⚙️ Установка\n\n```bash\ncomposer require andy87/sdk-php-client\n```\n\nТребования:\n\u003e ⚠️ Библиотека ориентирована на PHP 8.0+  \n- ext-curl  \n- ext-http  \n\n---\n\n## 📦 Структура\n\n### Основной клиент\n- **`SdkClient.php`** — базовый класс клиента, объединяющий модули, авторизацию и отправку запросов.\n  Используется как родительский класс при реализации конкретного клиента под API партнёра.\n---\n\n### Базовые компоненты\n- `base/components/Config.php` — конфигурация клиента\n- `base/components/Account.php` — учётные данные\n- `base/components/Prompt.php` — описание API-запроса\n- `base/components/Schema.php` — описание схемы ответа\n- `base/components/MockManager.php` — мок-ответы и заглушки\n\n### Интерфейсы\n- `AuthorizationInterface`\n- `RequestInterface`\n- `ResponseInterface`\n- `ClientInterface`\n- `MockInterface`\n\n### Модули\n- `base/modules/*` — абстрактные модули: логгер, транспорт, кэш, мок, тест\n\n### Транспорт\n- `transports/CurlTransport.php` — базовый HTTP-клиент на базе cURL\n\n### Утилиты `helpers/`\n- `ContentType.php`\n- `MethodRegistry.php`\n- `Protocol.php`\n\n### Core-ядро\n- `core/Modules.php` — менеджер модулей\n- `core/Container.php` — DI контейнер\n- `core/ClassRegistry.php` — подмена классов\n- `core/transport/*` — данные связанные с запросами `Query`, `Request`, `Response`, `Url`\n\n---\n\n## 🚀 Быстрый старт\n\n### Клиент\n```php\n\nclass CustomClient extends SdkClient\n{\n    // Для создания клиента достаточно реализовать методы с логикой под конкретного партнёра.\n    \n    public function authorization( Account $account, bool $isGetFromCache = true ): bool {\n        // Реализация авторизации\n    }\n    \n    public function isTokenInvalid( Response $response ): bool {\n        // Проверка отсутствия в ответеинформации о невалидном токене\n    }\n    \n    public function reAuthorization( Account $account ): bool {\n        // Реализация повторной авторизации если метод `isTokenInvalid` вернул true\n    }\n}\n```\n\n### Конфигурация\n```php\n\nuse andy87\\sdk\\client\\base\\interfaces\\ClientInterface;\nuse app\\components\\cusom\\modules\\CacheModule;\nuse app\\components\\cusom\\prompts\\CustomPrompt;\nuse app\\components\\cusom\\mock\\CustomPromptMock;\n\nclass CustomConfig extends Config\n{\n    // Базовые, обязательные, параметры клиента\n    protected string $protocol = Protocol::HTTPS; // Протокол ( по умолчанию `https` )\n    protected string $host; // Хост API, например `api.example.com`\n\n    // Расширенные, необязательные, параметры\n    protected ?string $prefix = null; // Префикс URL, например `/api/v1`\n    // на выхде для Prompt::$path = 'example` будет `https://api.example.com/api/v1/example`'\n\n    protected array $headers = []; // Дополнительные заголовки для всех запросов\n\n    // Переопределения используемых классов\n    protected array $registryOverrides = [\n        ClientInterface::CACHE =\u003e CacheModule::class, // Переопределение модуля кэша\n    ];\n\n    // Мок-ответы для тестирования ( список моков )\n    protected array $mockList = [\n        CustomPrompt::class =\u003e CustomPromptMock::class\n    ];\n    \n    // можно по необходимым условиям добавить дополнительные Mock-ответы\n    // используя метод `updateMockList( MockInterface[] )`\n\n}\n```\n\n\n### Prompt\nPrompt объекты, описывают API-запросы и их параметры.\n```php\nclass CustomPrompt extends Prompt\n{\n    // Базовые, обязательные, параметры запроса.\n    protected string $method = Method::GET; // Метод HTTP запроса ( по умолчанию `GET` )\n    \n    protected string $path = '/api/v1/resource'; // Путь к ресурсу API ( будет добавлен в конец `Config::$protocol`://`Config::$host`/`Config::$prefix`/{path} )\n\n    protected string $schema; // Схема ответа, например `CustomSchema::class` ( будет использоваться для валидации ответа и получения данных )\n\n\n\n    // Дополнительные, не обязательные параметры\n    protected array $headers = []; // Дополнительные заголовки для запроса ( будут добавлены к `Config::$headers` )\n\n    protected ?string $contentType = СontentType::JSON; // Значение устанавливаемое в заголовок 'Content-Type' ( по умолчанию `null` )\n\n    protected ?string $mock = SomeMock::class; // Если указан класс мок-ответа, он будет использоваться вместо реального запроса ( по умолчанию `null` )\n\n\n\n    // Управление логикой     \n    public const USE_PREFIX = false; // Отключение использования префикса из конфига ( по умолчанию `true` )\n\n    public const APPLY_QUERY_TO_URL = true; // При `true` данные из query string будут добавлены в URL ( по умолчанию `false` )\n\n    public const DEBUG = true; // Статус использования дебаг режима ( по умолчанию `false` )\n\n    public const AUTH = []; // Массив классов, реализующих интерфейс `AuthorizationInterface`, которые будут применены для добавления данных авторизации.\n}\n```\n\n### Схема\nСхемы описывают структуру ответа API и используются для валидации данных.\nСхема может быть многоуровневой, и может включать в себя другие схемы.\n```php\n\nclass CustomSchema extends Schema\n{\n    // Карта ассоциаций свойств с их схемами\n    public const MAPPING = [ \n        'coordinates' =\u003e Coordinates::class, //Схема для поля `coordinates`, которая должна быть реализована в классе `Coordinates`\n        'phones' =\u003e [Phones::class], // Массив схем для поля `phones`, каждый элемент массива будет реализована как объект класса `Phones`\n    ];\n\n    public string $id; // Поле без схемы, значение получается напрямую из ответа API\n\n    public bool $required; // Поле без схемы, значение получается напрямую из ответа API\n\n    /** @var array|sting[]  */\n    public array $ids = []; // Поле без схемы, значение получается напрямую из ответа API\n    \n    \n    // Свойства со схемами\n    public Coordinates $coordinates; // Схема для поля `coordinates`, которая должна быть реализована в классе `Coordinates`\n\n    /** @var array|Phones[]  */\n    public array $phones = []; // Массив схем для поля `phones`, каждый элемент массива будет реализована как объект класса `Phones`\n\n}\n```\n\n---\n\n## 🧩 Расширяемость\n\n- Все модули, компоненты и схемы подменяемы через `ClassRegistry` или DI.\n- Логика транспорта, кэша, логирования и мока абстрагирована в интерфейсы и базовые классы.\n\n---\n\n## ✅ Тесты\n\nСмотри `tests/SdkClientTest.php` как пример.\n\n---\n\n## 📄 Лицензия\n\nMIT\n\n---\n\n## 👤 Автор\n\n[and_y87](https://github.com/andy87)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandy87%2Fsdk-php-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandy87%2Fsdk-php-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandy87%2Fsdk-php-client/lists"}