maslosoft/api-facades

OpenAPI chainable facades generator

dev-master 2026-01-25 13:07 UTC

Requires

• php: >=8.3
• jane-php/open-api-3: *
• maslosoft/cli-shared: *
• maslosoft/embedi: ^2|^3
• maslosoft/light: ^1|^2
• monolog/monolog: ^3.10
• symfony/yaml: >2.6

Requires (Dev)

• codeception/codeception: ^5
• codeception/module-asserts: ^3
• codeception/module-phpbrowser: *
• maslosoft/codeception-reflection-asserts: ^1.0

MIT

• Peter Maselkowski

README

API Facades generator, allowing to call OpenAPI compatible API's with fluid interfaces.

The idea is to use natural path-like syntax, instead of method names clumps. The API call is basically last method which is the verb of request.

For example, POST to user account module API:

$api->ua->user->login->post($request);

Which sends post to: htttps://example.com/api/v1/ua/user/login

Example with GET:

$api->settlements->balance->show->get($request);

Or even shorter syntax:

$api->settlements->balance->show($request);

Which gets response from: htttps://example.com/api/v1/settlements/balance/show

Install

composer require maslosoft/api-facades --dev

Unit tests

To create unit test, make may be used with self-explanatory command, for example:

make unit Generate/Trim

Will generate new unit test class in:

tests/Unit/GenerateTrimTest.php

Keep in mind to use forward slash for namespace of tests, as \ may be interpreted as ascape character and generated class namespece will be wrong.

Templates

Templates are stored as md files. This allows syntax highlighting, while not showing errors when using placeholders.