This document discusses best practices for designing REST APIs. It covers identifying services, designing the API endpoints and database schema, using HTTP verbs like GET, POST, PUT and DELETE to perform CRUD operations on resources and collections, supporting sub-resources and nested URLs, handling pagination, versions, response formats, error codes, and advanced topics like security, rate limiting and caching.

1. Designing
REST APIs

2. Steps to create a backend
1. Identify Services
2. Design APIs
3. Design DB
@jjude

3. Steps to create a backend
1. Identify Services
2. Design APIs
3. Design DB
@jjude

4. Application
Programming
Interface
https://api.twitter.com/1.1/users/lookup.json

5. @jjude

6. figo.io
@jjude

7. /createAccount
API types
/modifyAccount
/updateAccount
/deleteAccount
/fetchAccountsForUsers
/fetchAccountBalance
action Based
@jjude

8. /createAccount
API types
/modifyAccount
/updateAccount
/deleteAccount
/fetchAccountsForUsers
/fetchAccountBalance
action Based ‘things’ Based
/account/create
/account/update
/account/read
/account/delete
/user/create
/user/update
/user/read
/user/delete
@jjude

9. /createAccount
API types
/modifyAccount
/updateAccount
/deleteAccount
/fetchAccountsForUsers
/fetchAccountBalance
action Based ‘things’ Based
/account/Create
/account/Update
/account/Read
/account/Delete
/user/create
/user/update
/user/read
/user/delete
@jjude

10. REpresentational
State Transfer
@jjude

11. REST = resources + verbs
/account/create
/account/update
/account/read
/account/delete
GET /account
POST /account
PUT /account
DEL /account
@jjude

12. Collections & Items
Create POST /customers /customers
Read GET /customers /customers/5
Update PUT /customers/5
Delete DELETE /customers /customers/5
@jjude

13. Sub-items
GET /customers/5/accounts
GET /customers/5/accounts/2
GET /customers/5/accounts/2/transactions
GET /customers/5/accounts/2/transactions/150
@jjude

14. Pagination
GET /customers/5/accounts/2/transactions/?page=3&per_page=100
GET /customers/5/accounts/2/transactions/?from=100&to=120
@jjude

15. Versions
/v1/customers/5/accounts
/customers/5/accounts?version=1
@jjude

16. Return Types
/v1/customers/5.json /customers/5/?format=json
/v1/customers/5.xml
/v1/customers/5/accounts.csv
/customers/5/?format=xml
/customers/5/accounts/?format=csv
@jjude

17. Errors / Return Codes
200 OK
301 Moved Permanently
303 Redirect
401 Unauthorised
404 Not Found
500 Internal Server Error
@jjude

18. Advanced Topics
security
rate limiting
caching
@jjude

19. Reference
http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api
@jjude