Update README.md

This commit is contained in:
GenZmeY 2021-03-20 23:03:59 +03:00 committed by GitHub
parent 60ff56654a
commit 58752d513f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,20 +1,20 @@
# go-jsonapi-example
`make && make run`
`make && make run`
## Create a new car:
`curl -X POST http://localhost:8080/v1/cars -d '{"data" : {"type" : "cars" , "attributes": {"brand" : "bmw", "model": "x5", "price": 999, "status": "OnTheWay"}}}'`
`curl -X POST http://localhost:8080/v1/cars -d '{"data" : {"type" : "cars" , "attributes": {"brand" : "bmw", "model": "x5", "price": 999, "status": "OnTheWay"}}}'`
## List cars:
`curl -X GET http://localhost:8080/v1/cars`
`curl -X GET http://localhost:8080/v1/cars`
## List paginated cars:
`curl -X GET 'http://localhost:8080/v1/cars?page\[offset\]=0&page\[limit\]=2'`
**OR**
`curl -X GET 'http://localhost:8080/v1/cars?page\[number\]=1&page\[size\]=2'`
`curl -X GET 'http://localhost:8080/v1/cars?page\[offset\]=0&page\[limit\]=2'`
**OR**
`curl -X GET 'http://localhost:8080/v1/cars?page\[number\]=1&page\[size\]=2'`
## Update:
`curl -X PATCH http://localhost:8080/v1/cars/1 -d '{ "data" : {"type" : "cars", "id": "1", "attributes": {"model" : "x3"}}}'`
`curl -X PATCH http://localhost:8080/v1/cars/1 -d '{ "data" : {"type" : "cars", "id": "1", "attributes": {"model" : "x3"}}}'`
## Delete:
`curl -X DELETE http://localhost:8080/v1/cars/2`
`curl -X DELETE http://localhost:8080/v1/cars/2`