This presentation shows the application of the REST patterns and Richardson`s maturity model by implementing a .Net Core WebApi project.

1. REST Applied

2. Hello!
I am Murilo Beltrame
Solution Architect @ Raízen | Tech Lead
@ Shellbox | Independent Consultor
You can find me at @murilobeltrame
2

3. Agenda
⬡ Why REST
⬡ HTTP Things
⬡ KISS
⬡ HATEOAS
3

4. 1.
Why REST
The World as a service

5. Shares &
Connect

6. 6

7. Richardson`s REST Maturity Model
7
KISS
Model the API to be logic and
easy to use for API`s clients. Do
not transfer implementation
complexity to outside world
3
https://www.crummy.com/writing/speaking/2008-QCon/act3.html

8. HTTP RFCs
REST is based on HTTP
Specification. Follow the URL
guidelines, link actions to HTTP
Verbs and follow the HTTP Status
Code semantics.
2
KISS
Model the API to be logic and
easy to use for API`s clients. Do
not transfer implementation
complexity to outside world
3
8
Richardson`s REST Maturity Model
https://www.crummy.com/writing/speaking/2008-QCon/act3.html

9. KISS
Model the API to be logic and
easy to use for API`s clients. Do
not transfer implementation
complexity to outside world
3
HTTP RFCs
REST is based on HTTP
Specification. Follow the URL
guidelines, link actions to HTTP
Verbs and follow the HTTP Status
Code semantics.
2
Richardson`s REST Maturity Model
9
HATEOAS
REST is about states. Use
hyperlinks to create the
application behavior.
1
https://www.crummy.com/writing/speaking/2008-QCon/act3.html

10. RESTful
REST is defined to be deeply
linked to HTTP’s RFCs so
Fielding state that a RESTful
API should be “level 3”
10https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm#sec_5_2

11. 2.
KISS
How to be a good citizen on a open service
world

12. Resource as nouns
/api/clients
12

13. Path Params
(remember what`s URL)
/api/clients/murilobeltrame
13

14. Versioning
/api/v1/clients
14

15. Versioning
/api/v1/clients
15

16. Versioning
/api/v1/clients
16

17. Paging, Sorting and Projection
/api/clients?_offset=2&_limit=10
17

18. Paging, Sorting and Projection
/api/clients?_offset=2&_limit=10
18

19. Swagger
19

20. 20
Place your screenshot here
Swagger

21. 21
Place your screenshot here
Swagger

22. 22
Place your screenshot here
Swagger

23. 23
Place your screenshot here
Swagger

24. 3.
HTTP Things
The Representational`s basis

25. Actions as HTTP Verbs
GET Read/List
POST Create
PUT/PATCH Update
DELETE Delete
25

26. HTTP Status Code Semantics
GET 200
POST 201
PUT/PATCH 200, 204
DELETE 200, 204
26

27. 5xx
Application Fault
27
4xx
Client Fault

28. HTTP Status Code Semantics
⬡ 400 – Bad Request
⬡ 401 – Unauthorized
⬡ 404 – Not Found
⬡ 403 – Forbidden
⬡ 409 – Conflict
⬡ 422 – Unprocessable *
⬡ 426 – Upgrade Required *
28

29. Requests & Responses
29

30. Requests & Responses
30

31. 4.
HATEOAS
The APEX of a hyper link based application

32. “REST is defined by four
interface constraints:
identification of resources;
manipulation of resources
through representations;
self-descriptive messages;
and, hypermedia as the
engine of application state.
– Fielding, R. T. - 2000
32

33. 33

34. HATEOAS
34

35. 35
Place your screenshot here
HATEOAS

36. 36
Place your screenshot here
HATEOAS

37. References
⬡ https://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm
⬡ https://martinfowler.com/articles/richardsonMaturityModel.html
⬡ https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design
⬡ https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-
implementation
⬡ https://swagger.io/specification/
⬡ https://tools.ietf.org/html/rfc2616
⬡ https://tools.ietf.org/html/rfc4918
⬡ https://tools.ietf.org/html/rfc5988
37

38. 38
Thanks!
Any questions?
You can find me at:
@murilobeltrame
murilobeltrame@gmail.com