phramework/jsonapi-client

JSONAPI client, helps creating SDK to consume your JSON API services

v2.6.7 2021-06-18 13:39 UTC

Requires

• php: ^7.3|^8.0.0
• guzzlehttp/guzzle: ^6.3.3|^7.1.1
• phramework/operator: *
• phramework/util: ^0.0.0

Requires (Dev)

• codacy/coverage: ^1.0
• mockery/mockery: ^1.4.3
• oscarotero/psr7-middlewares: ^3.16
• phpunit/phpunit: ^8.0.0
• phramework/jsonapi: 3.x-dev
• phramework/validate: 1.0.0-RC4
• roave/security-advisories: dev-master
• satooshi/php-coveralls: ^1.0
• slim/slim: ^3.0
• squizlabs/php_codesniffer: *

Apache-2.0

• Xenofon Spafaridis
• Alexandros Kalliontzis

README

JSONAPI client, helps creating SDK to consume your JSON RESTful APIs

Usage

Require package using composer

composer require phramework/jsonapi-client

GET a collection

<?php
/**
 * Define an API endpoint
 */
$endpoint = (new Endpoint('article'))
    ->setUrl('http://localhost:8005/article/');

/**
 * Get a collection of all `article`s, including their author
 */
$response = $endpoint->get(
    new IncludeRelationship('author')
);

/*
 * Display article collection
 */
print_r($articles = $response->getData());

License

Copyright 2016-2019 Xenofon Spafaridis

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.