README

OpenAPI

A lightweight OpenAPI HTTP kernel built on Guzzle, providing extensible request builders, endpoint chaining, and middleware pipelines.

Installation

You can install the package via Composer:

composer require nacosvel/openapi

[back to top]

Usage

Builder Initialization

use Nacosvel\OpenAPI\Builder;

$instance = Builder::factory([
    'mchid' => '190000****',
], [
    'base_uri' => 'https://httpspot.dev/',
]);

Middleware Registration

use Nacosvel\OpenAPI\Middleware\Middleware;

$instance->addMiddleware([
    new Middleware($builder->getClientDecorator()->getConfig()),
]);

Synchronous Request

$response = $builder->chain('anything/{code}')->get([
    'query' => [
        'id' => 1,
    ],
    'code'  => rand(100000, 999999),
]);

var_dump($response->getBody()->getContents());

Asynchronous Requests

use Psr\Http\Message\ResponseInterface;

$response = $builder->anything->_code_->getAsync([
    'query' => [
        'id' => 1,
    ],
    'code'  => rand(100000, 999999),
])->then(function (ResponseInterface $response) {
    return $response->getBody()->getContents();
})->wait();

var_dump($response);

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

[back to top]

Contributors

Thanks goes to these wonderful people:

Contributions of any kind are welcome!

[back to top]

License

Distributed under the MIT License (MIT). Please see License File for more information.

[back to top]