nas/todo_api
2
1
Fork 0
Code Issues 1 Pull requests Releases Wiki Activity

Updated docs to reflect int and float being outputed as numbers instead of strings

Browse source
This commit is contained in:
Maurits van der Schee 2016-11-30 01:15:00 +01:00
commit f0ec4ac3aa
1 changed files with 42 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

84
README.md
View file

@ -127,7 +127,7 @@ GET http://localhost/api.php/categories
Output: Output:
``` ```
{"categories":{"columns":["id","name"],"records":[["1","Internet"],["3","Web development"]]}} {"categories":{"columns":["id","name"],"records":[[1,"Internet"],[3,"Web development"]]}}
``` ```
### List + Transform ### List + Transform
@ -141,7 +141,7 @@ GET http://localhost/api.php/categories?transform=1
Output: Output:
``` ```
{"categories":[{"id":"1","name":"Internet"},{"id":"3","name":"Web development"}]} {"categories":[{"id":1,"name":"Internet"},{"id":3,"name":"Web development"}]}
``` ```
NB: This transform is CPU and memory intensive and can also be executed client-side (see: [lib](https://github.com/mevdschee/php-crud-api/tree/master/lib)). NB: This transform is CPU and memory intensive and can also be executed client-side (see: [lib](https://github.com/mevdschee/php-crud-api/tree/master/lib)).
@ -176,7 +176,7 @@ GET http://localhost/api.php/categories?filter=categories.id,eq,1
Output: Output:
``` ```
{"categories":{"columns":["id","name"],"records":[["1","Internet"]]}} {"categories":{"columns":["id","name"],"records":[[1,"Internet"]]}}
``` ```
NB: You may specify table name before the field name, seperated with a dot. NB: You may specify table name before the field name, seperated with a dot.
@ -195,7 +195,7 @@ GET http://localhost/api.php/categories?filter[]=id,ge,1&filter[]=id,le,3
Output: Output:
``` ```
{"categories":{"columns":["id","name"],"records":[["1","Internet"],["3","Web development"]]}} {"categories":{"columns":["id","name"],"records":[[1,"Internet"],[3,"Web development"]]}}
``` ```
NB: You may specify "satisfy=categories.all,posts.any" if you want to mix "and" and "or" for different tables. NB: You may specify "satisfy=categories.all,posts.any" if you want to mix "and" and "or" for different tables.
@ -228,7 +228,7 @@ GET http://localhost/api.php/categories?order=name,desc
Output: Output:
``` ```
{"categories":{"columns":["id","name"],"records":[["3","Web development"],["1","Internet"]]}} {"categories":{"columns":["id","name"],"records":[[3,"Web development"],[1,"Internet"]]}}
``` ```
### List + Order + Pagination ### List + Order + Pagination
@ -243,7 +243,7 @@ GET http://localhost/api.php/categories?order=id&page=1,50
Output: Output:
``` ```
{"categories":{"columns":["id","name"],"records":[["1","Internet"],["3","Web development"]],"results":2}} {"categories":{"columns":["id","name"],"records":[[1,"Internet"],[3,"Web development"]],"results":2}}
``` ```
NB: Pages that are not ordered cannot be paginated. NB: Pages that are not ordered cannot be paginated.
@ -271,7 +271,7 @@ Alternatively you can send a JSON object in the body. The call returns the "last
``` ```
POST http://localhost/api.php/categories POST http://localhost/api.php/categories
{"id":"1","name":"Internet"} {"id":1,"name":"Internet"}
``` ```
Output: Output:
@ -310,7 +310,7 @@ GET http://localhost/api.php/categories/1
Output: Output:
``` ```
{"id":"1","name":"Internet"} {"id":1,"name":"Internet"}
``` ```
### Read (multiple) ### Read (multiple)
@ -324,7 +324,7 @@ GET http://localhost/api.php/categories/1,2
Output: Output:
``` ```
[{"id":"1","name":"Internet"},{"id":"2","name":"Programming"}] [{"id":1,"name":"Internet"},{"id":2,"name":"Programming"}]
``` ```
### Update ### Update
@ -433,9 +433,9 @@ Output:
], ],
"records": [ "records": [
[ [
"1", 1,
"1", 1,
"1", 1,
"blog started" "blog started"
] ]
] ]
@ -451,14 +451,14 @@ Output:
], ],
"records": [ "records": [
[ [
"1", 1,
"1", 1,
"1" 1
], ],
[ [
"2", 2,
"1", 1,
"2" 2
] ]
] ]
}, },
@ -472,7 +472,7 @@ Output:
], ],
"records": [ "records": [
[ [
"1", 1,
"anouncement" "anouncement"
] ]
] ]
@ -487,11 +487,11 @@ Output:
], ],
"records": [ "records": [
[ [
"1", 1,
"funny" "funny"
], ],
[ [
"2", 2,
"important" "important"
] ]
] ]
@ -507,13 +507,13 @@ Output:
], ],
"records": [ "records": [
[ [
"1", 1,
"1", 1,
"great" "great"
], ],
[ [
"2", 2,
"1", 1,
"fantastic" "fantastic"
] ]
] ]
@ -527,26 +527,26 @@ You can call the ```php_crud_api_tranform()``` function to structure the data hi
{ {
"posts": [ "posts": [
{ {
"id": "1", "id": 1,
"post_tags": [ "post_tags": [
{ {
"id": "1", "id": 1,
"post_id": "1", "post_id": 1,
"tag_id": "1", "tag_id": 1,
"tags": [ "tags": [
{ {
"id": "1", "id": 1,
"name": "funny" "name": "funny"
} }
] ]
}, },
{ {
"id": "2", "id": 2,
"post_id": "1", "post_id": 1,
"tag_id": "2", "tag_id": 2,
"tags": [ "tags": [
{ {
"id": "2", "id": 2,
"name": "important" "name": "important"
} }
] ]
@ -554,21 +554,21 @@ You can call the ```php_crud_api_tranform()``` function to structure the data hi
], ],
"comments": [ "comments": [
{ {
"id": "1", "id": 1,
"post_id": "1", "post_id": 1,
"message": "great" "message": "great"
}, },
{ {
"id": "2", "id": 2,
"post_id": "1", "post_id": 1,
"message": "fantastic" "message": "fantastic"
} }
], ],
"user_id": "1", "user_id": 1,
"category_id": "1", "category_id": 1,
"categories": [ "categories": [
{ {
"id": "1", "id": 1,
"name": "anouncement" "name": "anouncement"
} }
], ],
@ -629,7 +629,7 @@ GET http://localhost/api.php/categories/2
Output: Output:
``` ```
{"id":"2","name":"funny","icon":"ZGF0YQ=="} {"id":2,"name":"funny","icon":"ZGF0YQ=="}
``` ```
When sending a record that contains a binary field you will also have to send base64 encoded data. When sending a record that contains a binary field you will also have to send base64 encoded data.