Downloaded 20 times
![JSON 2 Case Class [Scala]
http://json2caseclass.cleverapps.io/http://json2caseclass.cleverapps.io/
.json
.scala](https://image.slidesharecdn.com/publicapi-150311145207-conversion-gate01/75/Developing-a-Public-API-at-Reversim-Summit-2015-29-2048.jpg)
Uploaded byYonatan Maman
Developing a Public API -- at Reversim Summit 2015
The document discusses best practices for building a public API, emphasizing consistency, error handling, and user expectations. It highlights the importance of resource-focused design, maintaining compatibility, and effective documentation. Additional topics include security considerations, rate limiting, and testing strategies.
More Related Content
![[GeekTalk#2] Takaaki Mizuno - Api Url Design](https://cdn.slidesharecdn.com/ss_thumbnails/apiurldesign-161013034542-thumbnail.jpg?width=640&height=640&fit=bounds)
Similar to Developing a Public API -- at Reversim Summit 2015
Developing a Public API -- at Reversim Summit 2015
- 1. Things you shouldknow Building a Public API }During Before After
- 2.
- 3. Outbrain 0.5B> 190B Unique VisitorsRecommendationS per Month
- 4. “Boss, Boss hi APIi 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
- 5.
- 6.
- 7.
- 8.
- 9. Be consistently consistent * HTTPmethods * HTTP codes * Headers * Authentication No one likes surprises Make your users feel at home Use Standards: Error handling
- 10. It is allabout the Expectations GET POST PUT /customers/{id} /customers /customers REQUEST RESPONSE customerGET customercustomer customercustomer* 200 201 200
- 11.
- 12. GET /customer/1/orders || !toembed GET /customers/1
- 13. Can we haveboth ? 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
- 16.
- 17.
- 18. Documentation apiary.io Swager Mashape and More... apiary.io Swager Mashapeand More... * Be consistent * Focus on Resources * Less > More * Examples * Be consistent * Focus on Resources * Less > More * Examples במקביל עבודה " ”דביל לכל הצלחה – במקביל עבודה " ”דביל לכל הצלחה – ** Sand-box ? +1** Sand-box ? +1
- 19.
- 20.
- 21.
- 22. * UX –interactions * UI – documentation * Ideas to new features * Bugs Eat your own dog food Tip #1
- 23. Tip #2 What's wrongwith using DB IDs as your entity IDs? GET /customers/1
- 24. “Authorization” “privacy” , yourprivacy “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 URIshould 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 ? NotReally ! != Internal Model Retrieve != Update != Create
- 29. JSON 2 CaseClass [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 totalk 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