An open API service indexing awesome lists of open source software.

https://github.com/phramework/jsonapi-client

JSONAPI client, helps creating SDK to consume your JSON API services
https://github.com/phramework/jsonapi-client

jsonapi

Last synced: 2 months ago
JSON representation

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

Awesome Lists containing this project

README

          

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

[![Build Status](https://travis-ci.org/phramework/jsonapi-client.svg?branch=2.x)](https://travis-ci.org/phramework/jsonapi-client)

[![Coverage Status](https://coveralls.io/repos/github/phramework/jsonapi-client/badge.svg?branch=2.x)](https://coveralls.io/github/phramework/jsonapi-client?branch=2.x)

## Usage
Require package using composer
```bash
composer require phramework/jsonapi-client
```

### GET a collection

```php
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.