Skip to content

Commit 433c03c

Browse files
committed
Update
1 parent d35118f commit 433c03c

File tree

3 files changed

+27
-10
lines changed

3 files changed

+27
-10
lines changed

README.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,37 @@
66

77
## Description
88

9-
Framework agnostic [JSON API](http://jsonapi.org/) implementation.
9+
A good API is one of most effective ways to improve the experience for your clients. Standardized approaches for data formats and communication protocols increase productivity and make integration between applications smooth.
1010

11-
This package covers encoding PHP objects to JavaScript Object Notation (JSON) as described in [JSON API Format](http://jsonapi.org/format/).
11+
This framework agnostic package fully implements [JSON API](http://jsonapi.org/) specification and helps you to focus on core application functionality rather than on protocol implementation. It supports document structure, errors and data fetching as described in [JSON API Format](http://jsonapi.org/format/). As it is designed to stay framework agnostic for practical usage it requires framework integration. [Limoncello](https://github.com/neomerx/limoncello) is an example of integration with Symfony based projects.
12+
13+
If you are looking for quick start application consider [Limoncello collins](https://github.com/neomerx/limoncello-collins) which is a pre-configured Laravel-based quick start application.
14+
15+
Encoding fully support
1216

1317
* Resource attributes and complex attributes
18+
* Compound documents with included resources
19+
* Circular resource references
1420
* Meta information for document, resources and link objects
1521
* Link objects (including links as references, links to null and empty arrays)
16-
* Compound documents with included resources
1722
* Limits for input data parsing depth
18-
* Circular references in resources
1923
* Sparse fieldset filter rules
2024
* Pagination links
2125
* Errors
2226

23-
## Versioning
27+
The package covers all the complexity of parsing and checking request parameters and headers. For instance it helps to correctly respond with ```Unsupported Media Type``` (HTTP code 415) and ```Not Acceptable``` (HTTP code 406) to invalid requests. You don't need to manually validate all input parameters on every request. You can configure what parameters are supported by your services and this package will check incoming requests automatically. It greatly simplifies API development. All parameters from the specification are supported
28+
29+
* Inclusion of related resources
30+
* Sparse fields
31+
* Sorting
32+
* Pagination
33+
* Filtering
2434

25-
This package implements the latest [JSON API](http://jsonapi.org/) version RC3 and is using [Semantic Versioning](http://semver.org/).
26-
The package version reflects the fact JSON API specification has not been finally released yet but not the package readiness.
35+
## Contributing
36+
37+
JSON API specification is at a third release candidate state and may have some tweaks. If you have spotted any specification changes that are not reflected in this package please post an [issue](https://github.com/neomerx/json-api/issues).
38+
39+
Thank you for your support :star:.
2740

2841
## Install
2942

@@ -63,7 +76,7 @@ will output
6376
}
6477
```
6578

66-
The ```AuthorSchema``` looks like
79+
The ```AuthorSchema``` provides information about resource's fields and might look like
6780

6881
```php
6982
class AuthorSchema extends SchemaProvider
@@ -438,6 +451,10 @@ Do not hesitate to contact us on [![Gitter](https://badges.gitter.im/Join%20Chat
438451
$ phpunit
439452
```
440453

454+
## Versioning
455+
456+
This package is using [Semantic Versioning](http://semver.org/).
457+
441458
## Credits
442459

443460
- [Neomerx](https://github.com/neomerx)

sample/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ The following command could be used for performance profiling with [blackfire.io
5757
$ blackfire --slot <slot number here> --samples 1 run php -d assert.active=0 sample.php -t=100
5858
```
5959

60-
Are you in a mood to optimize performance? You can start from this [performance baseline profile](https://blackfire.io/profiles/6a0b22eb-733a-4b0e-ba13-e563e66c07c7/graph).
60+
Are you in a mood to optimize performance? You can start from this [performance baseline profile](https://blackfire.io/profiles/62063105-9033-498a-b14d-00c6facf68fd/graph).

sample/composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@
1616
},
1717
"minimum-stability": "dev",
1818
"require": {
19-
"neomerx/json-api": "0.2"
19+
"neomerx/json-api": "0.2.2"
2020
}
2121
}

0 commit comments

Comments
 (0)