Introduction to APIs - What, Why and How at CodeCore Bootcamp
•
1 j'aime•1,200 vues
The following presentation was given at CodeCore Community Week in April. You can find a full video of the presentation here: http://www.codecore.ca/apis-what-why-and-how-with-ganesh-swami-of-silota/ Whether you are building for the web, mobile, or devices yet to be invented, the enabling technology behind them are APIs. In this talk, Ganesh introduced APIs, describe what makes them possible, the process for creating APIs and supporting them. Ganesh is the founder of Silota -- a Search as a Service API. He started his programming career writing high performance algorithms for protein simulations. He likes the challenge of taking complex topics and explaining them to a beginner.
Recommandé
Recommandé
Contenu connexe
Dernier
Dernier (20)
En vedette
En vedette (20)
Introduction to APIs - What, Why and How at CodeCore Bootcamp
- 1. Introduction to APIs CodeCore Community Week April 25, 2014 Ganesh Swami www.silota.com
- 2. Hi • Programming professionally for 10+ years • x86 assembly, STL, boost, python-boost, python
- 3. SILOTA • Search As A Service • full stack: crawling, indexing, retrieving, tag deployment • First class developer experience (DX) • documentation • testing • sandbox • 800+ search engines in production!
- 4. APIs: What & Why
- 5. What is an API? Application Programming Interface ! An API is the interface implemented by an application which allows other applications to communicate with it.
- 6. What is an API? communicate
- 7. Why build an API? • explosion of devices connected to the internet • can be a company’s greatest asset • bizdev 2.0: internal developers, consultants, partners, customers
- 8. Sample APIs • aws • dropbox • instagram • pinterest • github • stripe • salesforce • twillio • …
- 9. Source: Mary Meeker’s Internet Trends 2013
- 10. APIs: How
- 11. What is REST? • REpresentational State Transfer • logical resources manipulated with HTTP verbs • modern best practice • wide adoption • contrast with SOAP
- 12. HTTP Clients Request Response GET /simtec/httpgallery/introduction/ HTTP/1.1 Accept:*/* Accept-‐Language: en-‐gb Accept-‐Encoding: gzip, deflate User-‐Agent: Mozilla/4.0 (compatible; MSIE 6.0) Host: www.httpwatch.com Connection: Keep-‐Alive ! ! ! ! ! HTTP/1.1 200 OK Server: Microsoft-‐IIS/5.1 Date: Mon, 04 Oct 2004 12:04:43 GMT X-‐Powered-‐By: ASP.NET X-‐AspNet-‐Version: 1.1.4322 Cache-‐Control: no-‐cache Pragma: no-‐cache Expires: -‐1 Content-‐Type: text/html; charset=utf-‐8 Content-‐Length: 8307 ! <html> <head> ...
- 13. HTTP Verbs • GET, POST, PUT, PATCH, DELETE
- 14. Status Codes 2xx OK, created, all good, carry on 4xx User error: bad API key, malformed data, item not found, etc. 5xx Server error
- 15. Embrace HTTP GET /document Retrieve all documents GET /document/19 Retrieve a specific document #19 POST /document Create a new document PUT /document/19 Update an existing document #19 DELETE /document/19 Delete an existing document #19
- 18. Bipartite graph /documents /documents/:id … GET POST error PUT error PATCH error DELETE
- 20. Best practices security https all the way base URLs api.companyname.com serialization json timestamps ISO 8601 & UTC versioning /v1/ caching ETag & Last-Modified gzip always & pretty print responses logging if possible
- 21. Recap • https + gzip + json • use bipartite graph of nouns and verbs • great documentation • no surprises
- 23. Read on www.silota.com next week!
- 25. The Pitch BENEFITSCOSTS What We Give (investment) What We Get (return)
- 26. References • How to Design a Good API and Why it Matters: • http://lcsd05.cs.tamu.edu/slides/keynote.pdf • Best Practices for Designing a Pragmatic RESTful API • http://www.vinaysahni.com/best-practices-for-a-pragmatic- restful-api • REST worst practices: • http://jacobian.org/writing/rest-worst-practices/ • Building RESTful APIs: http://www.slideshare.net/silota/building- restful-apis
- 27. Keep in touch! Ganesh Swami! www.silota.com ganesh@silota.com @gane5h