Skip to content

Commit e400be8

Browse files
authored
Update README.md
1 parent 2f0a524 commit e400be8

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,20 @@
55

66
json-api-server is a [JSON:API](http://jsonapi.org) server implementation in PHP.
77

8-
Build an API in minutes by defining your API's schema and connecting it to your application's models. json-api-server takes care of all the boilerplate stuff like routing, query parameters, and building a valid JSON:API document.
8+
It allows you to define your API's schema, and then use an [adapter](adapters.md) to connect it to your application's database layer. You don't have to worry about any of the server boilerplate, routing, query parameters, or JSON:API document formatting.
9+
10+
Based on your schema definition, the package will serve a **complete JSON:API that conforms to the [spec](https://jsonapi.org/format/)**, including support for:
11+
12+
- **Showing** individual resources (`GET /api/articles/1`)
13+
- **Listing** resource collections (`GET /api/articles`)
14+
- **Sorting**, **filtering**, **pagination**, and **sparse fieldsets**
15+
- **Compound documents** with inclusion of related resources
16+
- **Creating** resources (`POST /api/articles`)
17+
- **Updating** resources (`PATCH /api/articles/1`)
18+
- **Deleting** resources (`DELETE /api/articles/1`)
19+
- **Error handling**
20+
21+
The schema definition is extremely powerful and lets you easily apply [permissions](visibility.md), [transformations](writing.md#transformers), [validation](writing.md#validation), and custom [filtering](filtering.md) and [sorting](sorting.md) logic to build a fully functional API with ease.
922

1023
## Documentation
1124

0 commit comments

Comments
 (0)