somnambulist / api-client
A library to help ease creating API integrations
Installs: 2 291
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 4
Forks: 0
Open Issues: 0
Requires
- php: >=8.1
- ext-json: *
- beberlei/assert: ^3.0
- pagerfanta/pagerfanta: ^3.5
- psr/log: ^1|^2|^3
- somnambulist/attribute-model: ^3.0
- somnambulist/collection: ^5.3
- symfony/event-dispatcher: ^6.4|^7.0
- symfony/http-client: ^6.4|^7.0
- symfony/routing: ^6.4|^7.0
Requires (Dev)
- phpunit/phpunit: ^10.5
- somnambulist/domain: ^5.0
- symfony/framework-bundle: ^6.4
- symfony/phpunit-bridge: ^6.4
- symfony/var-dumper: ^6.4
This package is auto-updated.
Last update: 2024-10-31 00:18:16 UTC
README
The ApiClient library is intended to help build client libraries for consuming JSON APIs. The library provides abstract models for primary resource objects and related value objects. Persistence requests are handled by ApiActions that encapsulate a change request.
Models and ValueObjects make use of somnambulist/attribute-model type casting system.
The library uses Symfony HTTP Client under the hood.
Requirements
- PHP 8.1+
- cURL
- symfony/event-dispatcher
- symfony/http-client
- symfony/routing
Installation
Install using composer, or checkout / pull the files from github.com.
- composer require somnambulist/api-client
Usage
This library provides some building blocks to help you get started with consuming RESTful APIs. Typically, this is for use with a micro-services project where you need to write clients that will be shared amongst other projects.
Please note: this project does not make assumptions about the type of service being used. The included libraries provide suitable defaults, but can be completely replaced by your own implementations.
The docs are available in the docs folder with a suggested reading order as follows:
- upgrade notes 1.X
- upgrade notes 2.X
- upgrade notes 3.X
- adding routes
- defining API connections
- expected JSON structure
- using Models and ValueObjects
- searching and querying
- type casting attributes
- model relationships
- storing data
- recording API responses
Tests
PHPUnit 9+ is used for testing. Run tests via vendor/bin/phpunit.
Test data was generated using faker and was randomly generated.