You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
JsonApiClient is a PHP Library to validate and handle the response body from a [JSON API](http://jsonapi.org) Server.
9
+
JsonApiClient :construction_worker_woman:is a PHP Library to validate and handle the response body from a [JSON API](http://jsonapi.org) Server.
10
10
11
11
Format: [JSON API 1.0](http://jsonapi.org/format/1.0/)
12
12
13
-
### WIP: Goals for 1.0
13
+
##:checkered_flag: Goals
14
14
15
-
*[x] Be 100% JSON API 1.0 spec conform
16
-
*[x] Handle/validate a server response body
17
-
*[x] Offer an easy way to retrieve the data
18
-
*[x] Be extendable and allow injection of classes/models
19
-
*[x] Handle/validate a client request body
20
-
*[ ] Refactore and remove the deprecated code
15
+
*:heavy_check_mark: Be 100% JSON API spec conform
16
+
*:heavy_check_mark: Be open for new spec versions
17
+
*:heavy_check_mark: Handle/validate a server response body
18
+
*:heavy_check_mark: Handle/validate a client request body
19
+
*:heavy_check_mark: Offer an easy way to retrieve the data
20
+
*:heavy_check_mark: Allow extendability and injection of classes/models
21
21
22
-
### Upgrade notice
22
+
##:package: Install
23
23
24
-
JsonApiClient can be considered as stable and version 0.10 will be the last development version.
24
+
Via Composer
25
+
26
+
```bash
27
+
$ composer require art4/json-api-client
28
+
```
29
+
30
+
### :building_construction: Development notice
31
+
32
+
**JsonApiClient can be considered as stable** and version 0.10 will be the last development version.
25
33
26
34
After version 0.8 there where no breaking changes. Every change was backward compatible and every functionality that will be removed in future now only triggers a deprecated warning.
27
35
@@ -35,21 +43,13 @@ This simply means for you:
35
43
36
44
(Compare the [Symfony upgrade documentation](https://symfony.com/doc/current/setup/upgrade_major.html))
37
45
38
-
#### Attention for older versions
46
+
#### :warning:Attention for older versions
39
47
40
48
Version 0.6.1 and below interprets the pagination links wrong. Make sure you are using the latest version of JsonApiClient. See [#19](https://github.com/Art4/json-api-client/issues/19), [#23](https://github.com/Art4/json-api-client/pull/23) and [#26](https://github.com/Art4/json-api-client/pull/26) for more information.
41
49
42
-
## Install
43
-
44
-
Via Composer
45
-
46
-
```bash
47
-
$ composer require art4/json-api-client
48
-
```
49
-
50
-
## Usage
50
+
## :rocket: Usage
51
51
52
-
See the [documentation](docs/README.md).
52
+
See the [quickstart guide](docs/helper-parser.md) or the [documentation](docs/README.md).
53
53
54
54
### Using as parser
55
55
@@ -116,25 +116,25 @@ if ( Parser::isValidResponseString($wrong_jsonapi) ) {
116
116
117
117
Need more functionality? Want to directly inject your model? Easily extend JsonApiClient with the [Factory](docs/utils-factory.md).
118
118
119
-
## Changelog
119
+
## :loud_sound:Changelog
120
120
121
121
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
122
122
123
-
## Testing
123
+
## :white_check_mark:Testing
124
124
125
125
```bash
126
126
$ phpunit
127
127
```
128
128
129
-
## Contributing
129
+
## :wrench:Contributing
130
130
131
131
Please feel free to fork and sending Pull Requests. This project follows [Semantic Versioning 2](http://semver.org) and [PSR-2](http://www.php-fig.org/psr/psr-2/).
0 commit comments