Week 07: REST API, OpenAPI
PB138 - Se minar 07
1
Agenda
> GET /info/agenda
> Host: tutor.pb138
< HTTP/1.1 200
< Content-Type: text/markdown;charset=utf-8
< Server: Tutor
<
< - REST API
< - Naming activity
< - CRUD
< - OpenAPI
< - REST Client
< - Jest
< - Testing your API
< - Demo
< - REST, Swagger, Jest
2
Let's learn by doing...
... by saving animals from shelter!
Background story:
Animal Crossing is mobile application that provides to potential pet
owners simple and intuitive interface to adopt animal

from shelter. After making an adoption request the new owner will receive
guidelines for petting. Application also provides

access for caretakers to add a pet for adoption or mark it as adopted.
Every shelter must include REST API interface for application which
connect to Central API, to gather the data.
Note: All images are provided by OBČIANSKE ZDRUŽENIE TULÁČIK in
Brezno utuloktulacik.sk, cute dog is named Tootsie

Note: Application is inspired by Bc. Xuan Linh Phamová
3
Let's get creative!
After a basic understanding of the project description, now find the exact functional requirements of our
service that needs to be implemented.
Think about animals...
What about requests for adoption from users?
4
Let's get creative!
Add animal
Mark animal as adopted
Browse animals
Filter animals by type
Request adoption
You probably thought of more than these, it's good, but we
are only demoing.
5
From functional requirements to resources
What are the resources and endpoints here? What endpoints need to be implemented?
Add animal
Browse animals
Filter animals by type
Request adoption
Mark animal as adopted
Think of previous functions and try to find resources.
6
We have two models, one for Animals and another one for adoption requests.
model Animal { model Request {
name String from String
description String isAccepted Boolean
age Float
sex Boolean animal Animal
type String
picture String createdAt DateTime @default(now())
acceptedRequest Request? deletedAt DateTime?
requests Request[] }
addedAt DateTime
adoptedAt DateTime?
}
7
From functional requirements to REST API
Add animal
8
From functional requirements to REST API
POST /animals
JSON Body
9
From functional requirements to REST API
Browse animals
10
From functional requirements to REST API
GET /animals
11
From functional requirements to REST API
Filter animals by type and limit or other
12
From functional requirements to REST API
GET /animals?type=dog|cat&limit=2
13
From functional requirements to REST API
Request adoption
14
From functional requirements to REST API
POST /requests
JSON Body
15
From functional requirements to REST API
Mark animal as adopted
16
From functional requirements to REST API
PATCH /requests
JSON Body (isAccepted)
17
That's it let's implement it!
API is backed by Express
Documentation written in OpenAPI
Testing in Jest
18