recap-restful.pdf

1. Babel Coder
RECAP RESTFUL API

2. Babel Coder
RESTFUL
• Stands for “Representational State Transfer”
• RESTful Web Services are one way of providing interoperability between computer systems on
the Internet.

3. Babel Coder
CLIENT SERVER
Internet
Client Server

4. Babel Coder
RESOURCES
Internet
Client Server
User
Article
Comment

5. Babel Coder
UNIFORM INTERFACE
User
Article
Comment
URL
/users/1
GET
POST
PUT
PATCH
DELETE
HTTP VERBS

6. Babel Coder
ACTIONS
User
Article
Comment
URL
/users
GET
POST
PUT
PATCH
DELETE
List All Users
Create New User

7. Babel Coder
ACTIONS
User
Article
Comment
URL
/users/1
GET
POST
PUT
PATCH
DELETE
List the User
Partial Update the User
Delete the User

8. Babel Coder
MIME-TYPES
User
Article
Comment
URL
/users/1
HTML
XML
JSON
text/html
application/xml
application/json

9. Babel Coder
HTTP STATUS CODES
CODE STATUS
1xx Informational responses
2xx Success
3xx Redirection
4xx Client Errors
5xx Server Errors

10. Babel Coder
HTTP STATUS CODES
CODE STATUS
200 OK
201 Created
204 No Content
401 Unauthorized
404 Not Found
405 Method Not Allowed
422 Unprocessable Entity
500 Internal Server Error

11. Babel Coder
HTTP STATUS CODES
CODE STATUS
200 OK
201 Created
204 No Content
401 Unauthorized
404 Not Found
405 Method Not Allowed
422 Unprocessable Entity
500 Internal Server Error

12. Babel Coder
AUTHENTICATION

13. Babel Coder
auth-form-email
auth-form-password
auth-form-submit-button

14. Babel Coder
URL: http://127.0.0.1:5000/api/v1/auth/sign-up
Method: POST
Response Status Code: 201 CREATED
fl
ash-message

15. Babel Coder
auth-form-email
auth-form-password
auth-form-submit-button

16. Babel Coder
URL: http://127.0.0.1:5000/api/v1/auth/sign-in
Method: POST
Response Status Code: 200 OK
URL: http://127.0.0.1:5000/api/v1/xxx
Authorization: Bearer <ACCESS_TOKEN>
HTTP HEADERS

17. Babel Coder
URL: http://127.0.0.1:5000/api/v1/auth/pro
fi
le
Method: GET
Response Status Code: 200 OK
Authorization: Bearer <ACCESS_TOKEN>

18. Babel Coder
AUTHORIZATION

19. Babel Coder
URL: http://127.0.0.1:5000/api/v1/users
Authorization: Bearer <ACCESS_TOKEN>
ADMIN
200 OK

20. Babel Coder
URL: http://127.0.0.1:5000/api/v1/users
Authorization: Bearer <ACCESS_TOKEN>
Normal User
403 Forbidden

21. Babel Coder
Role-Based Access Control (RBAC)
Admin|Editor /api/v1/dashboard GET
Admin /api/v1/users/* GET|POST|PATCH|DELETE
Admin /api/v1/categories/* GET|POST|PATCH|DELETE
Admin|Editor /api/v1/articles/* GET|POST|PATCH|DELETE

22. Babel Coder
Admin|Editor

23. Babel Coder
Admin

24. Babel Coder
Admin

25. Babel Coder
Admin|Editor

26. Babel Coder

27. Babel Coder

28. Babel Coder

29. Babel Coder