Intro to APIs

Intended as an introductory talk to explain how APIs work for a members of the RIT Society of Software Engineers beginning a rapid development weekend.

Transcript

1. Web APIs, REST and the RapdevX API Wednesday, March 14, 12
2. What Are APIs? Wednesday, March 14, 12
3. 2 Major Classes Wednesday, March 14, 12
4. 2 Major Classes •Socket-based •HTTP-based Wednesday, March 14, 12
5. Socket APIs Wednesday, March 14, 12
6. How They Work Wednesday, March 14, 12
7. Server Client Wednesday, March 14, 12
8. Server Client Wednesday, March 14, 12
9. Server Client Wednesday, March 14, 12
10. Server Client Wednesday, March 14, 12
11. Server Client Wednesday, March 14, 12
12. Server Client Wednesday, March 14, 12
13. Server Client Wednesday, March 14, 12
14. Why not a socket API? Wednesday, March 14, 12
15. You need to consider: • low level networking concepts • data formatting • message formatting • when to read and write • ... Wednesday, March 14, 12
16. Sockets kind of suck! Wednesday, March 14, 12
17. HTTP APIs Wednesday, March 14, 12
18. HTTP The Protocol Wednesday, March 14, 12
19. HTTP Implementation Details Wednesday, March 14, 12
20. POST /hello Accept: application/json name=world Wednesday, March 14, 12
21. HTTP Methods Wednesday, March 14, 12
22. • CONNECT • PUT • POST • HEAD • OPTIONS • GET • TRACE • DELETE Wednesday, March 14, 12
23. • PUT • POST • GET • DELETE Wednesday, March 14, 12
24. POST /hello Accept: application/json name=world Wednesday, March 14, 12
25. Resources Wednesday, March 14, 12
26. • / • /hello/world • /posts/1/comments/3 Wednesday, March 14, 12
27. POST /hello Accept: application/json name=world Wednesday, March 14, 12
28. Headers Wednesday, March 14, 12
29. POST /hello Accept: application/json name=world Wednesday, March 14, 12
30. Request Body Wednesday, March 14, 12
31. API Technologies Wednesday, March 14, 12
32. SOAP Wednesday, March 14, 12
33. SOAP XML XML XML XML Wednesday, March 14, 12
34. REST Wednesday, March 14, 12
35. REST hates state! Wednesday, March 14, 12
36. CRUD operations Wednesday, March 14, 12
37. Create HTTP Post to Resource POST /puppies Read HTTP GET from the resources or from an instance of the resource GET /puppies/1 Update HTTP PUT to the instance of the resource PUT /puppies/1 Delete HTTP DELETE to the instance of the resource DELETE /puppies/1 Wednesday, March 14, 12
38. Transport Formats Wednesday, March 14, 12
39. •XML • More easily validated • More libraries and support • More data to push across, and thus slower •JSON • Much smaller • Great support in most modern languages • To do it truly correctly, it has to go through a JS interpreter Wednesday, March 14, 12
40. The RapdevX API Wednesday, March 14, 12
41. API Details Wednesday, March 14, 12
42. • REST • JSON Transport format • Python and Bottle implementation Wednesday, March 14, 12
43. API-level Design Wednesday, March 14, 12
44. Wednesday, March 14, 12