Developing a Public API -- at Reversim Summit 2015
•
4 likes•1,657 views
Developing a Public API. Things you should know while building a public API. Observation, conclusions, things we did good, things we could have done better while building Outbrain's "Amplify" Public API.
Recommended
More Related Content
What's hot
What's hot (19)
Viewers also liked
Viewers also liked (20)
Similar to Developing a Public API -- at Reversim Summit 2015
Similar to Developing a Public API -- at Reversim Summit 2015 (20)
Recently uploaded
Recently uploaded (20)
Developing a Public API -- at Reversim Summit 2015
- 1. Things you should know Building a Public API }During Before After
- 3. Outbrain 0.5B> 190B Unique Visitors RecommendationS per Month
- 4. “Boss, Boss hi API i not RESTful” * min {control on usage} * max {responsibility} * decisions.exist {_.takeAtDay1} * min {control on usage} * max {responsibility} * decisions.exist {_.takeAtDay1} Be Pragmatic Make reasonable compromise
- 9. Be consistently consistent * HTTP methods * HTTP codes * Headers * Authentication No one likes surprises Make your users feel at home Use Standards: Error handling
- 10. It is all about the Expectations GET POST PUT /customers/{id} /customers /customers REQUEST RESPONSE customerGET customercustomer customercustomer* 200 201 200
- 12. GET /customer/1/orders || !to embed GET /customers/1
- 13. Can we have both ? To embed || !to embed ? Simple All you need in one request Fewer transactions Simple All you need in one request Fewer transactions Fast Building block flexibility Cacheable Fast Building block flexibility Cacheable !to embed to embed and do it right ? *
- 14. Yes We Can ! GET /customers/1 GET /customers/1?embed=orders
- 15. Yes We Can #2 GET /customers/1
- 18. Documentation apiary.io Swager Mashape and More... apiary.io Swager Mashape and More... * Be consistent * Focus on Resources * Less > More * Examples * Be consistent * Focus on Resources * Less > More * Examples במקביל עבודה " ”דביל לכל הצלחה – במקביל עבודה " ”דביל לכל הצלחה – ** Sand-box ? +1** Sand-box ? +1
- 19. Documentation
- 20. Documentation
- 21. Documentation
- 22. * UX – interactions * UI – documentation * Ideas to new features * Bugs Eat your own dog food Tip #1
- 23. Tip #2 What's wrong with using DB IDs as your entity IDs? GET /customers/1
- 24. “Authorization” “privacy” , your privacy “Authorization” “privacy” , your privacy Bi Directional mapping using secret key- HOW? Tip #2 Add another column in the DB 27847321845691
- 25. Like a version OR /SUPPORT/multiple/VERSIONS/v2.5/ /SELL/your/soul/to/backwards/compatibility URI should control identity not presentation http://bit.ly/1Mo0yXF
- 26. ===> GET /customer/1 HTTP/1.1 Accept: application/outbrain.customer-v2.5+json ===> GET /customer/1 HTTP/1.1 Accept: application/outbrain.customer-v2.5+json <=== HTTP/1.1 200 OK Content-Type: application/outbrain.customer-v2.5+json <=== HTTP/1.1 200 OK Content-Type: application/outbrain.customer-v2.5+json Like a version
- 27. – One ? – Three ? – Four ? – One ? – Three ? – Four ? Quiz #3 How many Types do you need ? GET /customer/1 PUT /customer/1POST /customer/1
- 28. Clones ? Not Really ! != Internal Model Retrieve != Update != Create
- 29. JSON 2 Case Class [Scala] http://json2caseclass.cleverapps.io/http://json2caseclass.cleverapps.io/ .json .scala
- 30. 3 Security Tip #3 Translation 1 2 WebWeb Business Logic (API) 4 5 6 Events Cache
- 31. Much more to talk about * Security * Internal and Public API * Rate Limit * Testing * Rest maturity model * Security * Internal and Public API * Rate Limit * Testing * Rest maturity model Q ? A ! Thank You