Microservices and rest api's It is important to keep our services small as possible and using REST API we can achieve that. The slideshow give an overview the benefits of a rest api using Node.js or Java (could be any languages).

1. REST
Rest is a religion
RESTafarian VS Pragmatist

2. We all agree on
why REST
- Scalability
- Generality
- Independence
- Latency
- Security
- Encapsulation
Hottest new buzz word MicroServices

3. REST - KISS
Keep It Simple Stupid

4. How to start
Find your business entities
Understand the requirements

5. Find the Entities
Restaurants
Users

6. First: Collection
Second: Element
Collection/Element
[GET] restaurant/1
[GET] restaurant/1/cuisine
[GET] restaurants/cuisines/Chinese
Human readable no need to read any docs

7. Why Follow the Standard
1. Cause that’s the standard and we should follow it.
2. Easier time on documentation
3. We can write a request without using documentation.
4. using the same function for building request from different api end
point

8. REST
Formats
Http Method
Http status code
URI
Versioning
Request Body
Response Body
Paging
Caching
Search / Querying

9. Formats? JSON
Why Json?
- Ubiquity
- Simplicity
- Readability
- Scalability
- Flexibility
- Node.js/Mongo/Couch
I can read it!!

10. HTTP Methods
[POST] Create
[GET] Read
[PUT] Update
[Delete] Delete
Yes you can read with POST and delete with GET
This is not mean you should do it!

11. HTTP Status Code
[1XX] Info (100,101)
[2XX] Success (200,201)
[3XX]Redirect (301, 304)
[4XX] Client Error (401,404,405)
[5XX] Server Error (500,503)

12. BASE URL
api.opentable.com
VS
opentable.com/services/restaurants/api/v4/
version should be part of the header request default to the
newest
Media-Type: application/opentable+json;application&version=4

13. Request
URL: Should be simple and easy (Human Readable)
[GET] /restaurants/123/availability?orderBy=desc&…
Body/Payload
{
restaurantId: 123,
availability: {
…
}
}

14. Response
{
code: ‘ok’
status: 200,
body: {
restaurants: [
{
restaurant_id: 123,
reviews: [
{
review_id: 1,
…
}
]
},..
]
}
}

15. Paging
Facebook: limit/offset
Twitter page/rpp(RecordPerPage)
Linkedin Start/Count
The default is limit/offset

16. Search/Querying
/restaurants?q&time&date&cover&metroId&…
/users?q=<SOME_USERNAME>&sort=name|age

17. OpenTable
related topics

18. MicroServices
a list of some of our apis
Restaurants
Cuisines
Messages
Availability
Personalizer
…

19. The Keys
•Keep it Simple Stupid
•Keep it small service
•Dont care about the language use the right tool for the job
•Deliver fast
•Find the Entities
•Use a platform that lets you deploy fast
•REST is a common language (should be human readable)
•Good REST API is when people don't need your
documentation to guess the endpoint

20. Thanks
Github: Doron2402
Twitter: @segaldoron