Learn how to create REST APIs and be in peace with your mind by knowing how to structure them in a way that will provide an amazing experience for your users and also be easy to maintain and improve

1. rest
in
peace

2. lead software engineer
Wendell Adriel
Open Source Enthusiast
building solutions since
2009

3. TALK OVERVIEW
http status codes 101
put your methods to rest
standards matter
improve without breaking

4. 100 102 200 201 204
301 302 400 403 422
500 501 504
http status codes 101
???

5. http status codes 101
1xx
informational
3xx
redirection
5xx
server error
2xx
success
4xx
client error

6. http status 200

7. http status 201

8. http status 204

9. http status 401

10. http status 403

11. http status 404

12. http status 422

13. http status 500

14. http status 503

15. GET
Post
Put
Patch
Delete
put your methods to
rest
options
head
connect
trace
most common others

16. the “strange” ones
options
describe communication options
head
same as get, but without fetching the body
Connect
starts a 2-way communication
TRACE
returns the full HTTP request back

17. POST, PUT, PATCH ???
post
creates new resources
put
updates a resource as a whole
patch
updates a resource partially

18. endpoints
standards matter
responses
errors

19. get https://myapi.app/users
get https://myapi.app/post
get https://myapi.app/recent-posts
get https://myapi.app/popular_posts
naming your endpoints

20. get https://myapi.app/users/1
structure your
responses
get https://myapi.app/posts/10

21. POST https://myapi.app/users
structure your errors
POST https://myapi.app/posts

22. build trust
improve without
breaking
fix issues
reliable
provide value

23. versioning your api
using the url
https://myapi.app/v1/users
https://myapi.app/v2/users
using a subdomain
https://v1.myapi.app/users
https://v2.myapi.app/users
using an http header
x-api-version: 1
x-api-version: 2

24. let your crud rest
post https://myapi.app/v1/posts [201]
GET https://myapi.app/v1/posts [200]
get https://myapi.app/v1/posts/1 [200]
put https://myapi.app/v1/posts/1 [200/204]
patch https://myapi.app/v1/posts/1/publish [200/204]
delete https://myapi.app/v1/posts/1 [204]

25. https://wendelladriel.com @wendell_adriel