Download as PDF, PPTX
More Related Content
Similar to Best Practice in API Design
Best Practice in API Design
- 1. Best Practice inAPI Design
- 2. About Me •Lorna Jane Mitchell • http://lornajane.net • PHP consultant, developer, trainer • Author, speaker 2
- 3. Using APIs There arevarious stages: 1. publish 3
- 4. Using APIs There arevarious stages: 1. publish 2. dogfood 3
- 5. Using APIs There arevarious stages: 1. publish 2. dogfood 3. modularity 3
- 6.
- 7.
- 8.
- 9.
- 10.
- 11.
- 12.
- 13.
- 14. Status Codes: HeadlineNews Common codes: 200 OK 302 Found 301 Moved 401 Not Authorised 403 Forbidden 404 Not Found 500 Internal Server Error 12
- 15.
- 16. HTTP Headers Headers arethe metadata about the content we send/receive Useful headers: • Accept and Content-Type: used for content format negotiation 14
- 17.
- 18. HTTP Headers Headers arethe metadata about the content we send/receive Useful headers: • Accept and Content-Type: used for content format negotiation • User-Agent: to identify what made the request 16
- 19. HTTP Headers Headers arethe metadata about the content we send/receive Useful headers: • Accept and Content-Type: used for content format negotiation • User-Agent: to identify what made the request • Set-Cookie and Cookie: working with cookie data 16
- 20. HTTP Headers Headers arethe metadata about the content we send/receive Useful headers: • Accept and Content-Type: used for content format negotiation • User-Agent: to identify what made the request • Set-Cookie and Cookie: working with cookie data • Authorization: controlling access 16
- 21.
- 22.
- 23. HTTP Verbs • More than GET and POST • PUT and DELETE to update and delete in a RESTful service • HEAD, OPTIONS and others also specified GET Read POST Create In REST, we use: PUT Update DELETE Delete 19
- 24.
- 25.
- 26.
- 27.
- 28. RPC: Remote ProcedureCall • Single endpoint • Function name • Parameters • Return value • SOAP is a kind of RPC 24
- 29.
- 30.
- 31.
- 32.
- 33. RESTful Services •REpresentational State Transfer • URLs are unique resource identifiers • HTTP verbs indicate which operation should happen • We have full CRUD operations on a series of resources 29
- 34.
- 35.
- 36.
- 37.
- 38.
- 39.
- 40. Thanks! https://joind.in/6385 @lornajane http://lornajane.net/ 36