https://github.com/nitive/dog-diary
https://github.com/nitive/dog-diary
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nitive/dog-diary
- Owner: Nitive
- License: mit
- Created: 2021-05-01T14:29:33.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-05-03T14:30:42.000Z (about 5 years ago)
- Last Synced: 2025-03-25T20:39:57.693Z (over 1 year ago)
- Language: TypeScript
- Size: 99.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dog-diary
## REST API
### `POST /api/diaries` creates a dog diary
```sh
$ curl --request POST http://localhost:3000/api/diaries -H 'Content-Type: application/json' -d '{"dogName": "Арчи"}'
{"status":"ok","diary":{"id":"dd36545c-1ac2-442f-8d5c-98812dba76df","dogName":"Арчи"}}
```
### `GET /api/diaries/:diaryID` returns a dog diary by its ID
```sh
$ curl http://localhost:3000/api/diaries/70a28f2e-308a-47ef-815d-78919abd0173
{"status":"ok","diary":{"id":"70a28f2e-308a-47ef-815d-78919abd0173","dogName":"Берта"}}
```
### `PATCH /api/diaries/:diaryID` updates dog's name in diary
```sh
$ curl --request PATCH http://localhost:3000/api/diaries/70a28f2e-308a-47ef-815d-78919abd0173 -H 'content-type: application/json' -d '{"dogName": "Берта"}'
{"status":"ok"}
```
### `POST /api/diaries/:diaryID/entries` creates an entry in diary
```sh
$ curl --request POST http://localhost:3000/api/diaries/70a28f2e-308a-47ef-815d-78919abd0173/entries -H 'Content-Type: application/json' -d '{"time":"Mon, 03 May 2021 14:15:26 GMT","timePrecision":"minute","event":{"type":"urination","where":"outside"}}'
{"status":"ok","entity":{"id":"3d36f485-1898-46fd-9dc2-ab1fd3fad6cc","time":"2021-05-03T14:15:26.000Z","timePrecision":"minute","diaryID":"70a28f2e-308a-47ef-815d-78919abd0173","event":{"type":"urination","where":"outside"}}}
```
### `GET /api/diaries/:diaryID/entries` returns entries from diary
```sh
$ curl http://localhost:3000/api/diaries/70a28f2e-308a-47ef-815d-78919abd0173/entries -H 'Content-Type: application/json'
{"status":"ok","entities":[{"id":"3d36f485-1898-46fd-9dc2-ab1fd3fad6cc","time":"2021-05-03T14:15:26.000Z","timePrecision":"minute","diaryID":"70a28f2e-308a-47ef-815d-78919abd0173","event":{"type":"urination","where":"outside"}}]}
```