REST: Key Concepts

Main points of REST: Methods, Status codes, Error handling, Versioning, Documentation, Testing

Transcript

1. Rest Key Concepts
2. @adammbalogh Software developer
 Author of Phprest
3. https://github.com/phprest/phprest
4. Good To Know REST HTTP
5. REST with HTTP As a Web Dev We HTTP
7. Methods
8. Methods OPTIONS Returns available HTTP methods on resource(s) GET Retrieves resource(s) POST Creates a resource PUT Creates/Updates a resource PATCH Updates a resource (partially) DELETE Deletes a resource
9. OPTIONS /users Allow: GET,POST,DELETE Methods / Options
10. Methods / Put PUT for Creation Client specified ID PUT /products/16
11. Methods / Patch { “email”: “adam@gmail.com” } [ { "op": “replace", "path": “/email", "value": “adam@gmail.com“ } ]
12. Status Codes
14. Status Codes Status code Meaning 1xx Informational 2xx Success 3xx Redirection 4xx Client Error 5xx Server Error http://httpstatus.es/
15. Asynchronous operation Location: /queue/1337
16. Rate limiting
17. Errors Human readable Detailed error messages
18. Api Versioning
19. Api Versioning Breaking existing clients? v99
20. Api Versioning New version When?
21. “Your API is only as good as its documentation” API Documentation
22. API Documentation APIs for Humans
23. Swagger http://swagger.io/
25. API Blueprint https://apiblueprint.org
28. https://github.com/apiaryio/dredd
29. API Testing
30. Postman + Newman + Blueman API Testing Frisby.js CI
31. Thank you!