turbotraktor
/
ladylilia.com
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Update API README

Browse Source
master
Nikola Forró 7 years ago
parent 2645336b0b
commit 313a9be0d6
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File

10
api/README.md
Unescape View File

@ -7,7 +7,7 @@ GET /quotes/:id
```
```BASH
curl --request GET 'https://tld.example/api/quotes/28'
curl --request GET 'https://ladylilia.com/quotes/api/quotes/28'
```
Example response:
@ -30,7 +30,7 @@ GET /quotes
```
```BASH
curl --request GET --data 'https://tld.example/api/quotes?filter=cheese&sort_by=date&sort_order=asc'
curl --request GET --data 'https://ladylilia.com/quotes/api/quotes?filter=cheese&sort_by=date&sort_order=asc'
```
*Note: `X-Total-Count` header is set to a total number of quotes after filtering (useful for pagination)*
@ -73,7 +73,7 @@ POST /quotes
```
```BASH
curl --request POST --header 'X-Quotes-API-Key: SECRET_KEY' --data 'id=28&date=2018-01-01&game=IRL&text=Cheese?' 'https://tld.example/api/quotes'
curl --request POST --header 'X-Quotes-API-Key: __API_KEY__' --data 'id=28&date=2018-01-01&game=IRL&text=Cheese?' 'https://ladylilia.com/quotes/api/quotes'
```
*Note: the quote is replaced if it exists already*
@ -92,7 +92,7 @@ PUT /quotes/:id
```
```BASH
curl --request PUT --header 'X-Quotes-API-Key: SECRET_KEY' --data 'date=2018-01-01&game=IRL&text=Cheese?' 'https://tld.example/api/quotes/28'
curl --request PUT --header 'X-Quotes-API-Key: __API_KEY__' --data 'date=2018-01-01&game=IRL&text=Cheese?' 'https://ladylilia.com/quotes/api/quotes/28'
```
*Note: the quote is created if it doesn't exist yet*
@ -110,5 +110,5 @@ DELETE /quotes/:id
```
```BASH
curl --request DELETE --header 'X-Quotes-API-Key: SECRET_KEY' 'https://tld.example/api/quotes/28'
curl --request DELETE --header 'X-Quotes-API-Key: __API_KEY__' 'https://ladylilia.com/quotes/api/quotes/28'
```

Write Preview
Loading…
Cancel
Save