Learning to Share APIs

Originally Presented at O'Reilly Software Architecture Conf 4/13/2016

Transcript

1. Sanely Sharing APIs
2. Scott Feinberg
3. Our Agenda Today
4. APIs Cause Problems
5. APIs Divide Us
6. Friction Across Teams Information Silos Duplication of Effort
7. The Cause?
8. We Don’t Know How to Share Our APIs
9. Team A Team B
10. Team C Team D
11. Let’s learn to share
12. What makes for easy sharing?
13. If you do all these things I’m about to talk about...
14. Pick a Spec Format
15. What is a Spec?
16. OpenAPI/Swagger
17. Other Options
18. Want to see some specs?
19. Making Specs
20. Generate your specs
21. Generate your specs by proxy
22. Updating Spec during CI Builds
23. Why do you need specs?
27. Generate Good Documentation
28. Generate Integration Tests
29. How should your system talk to my system?
30. Canonical Protocols + Schemas
31. Pick a Protocol
32. Standardize Your Schema
33. Canonical Authentication
34. Design an Authentication Schema
35. Ways to Authenticate
36. Proxy-Based Authentication Proxy Lookup Key `dontshareme` User = Bob api.nytimes.com/svc/service_a/kittens/1?api-key=dontshareme Service A service_a.consul/kittens/1 header:{User=Bob}
37. Available Proxy or “API Gateway”
38. So what should I do?
39. Your Sharing Checklist
40. The new process for creating an API...
43. New York Times Developer APIs
44. NYT Developer API Program
45. Announcing Today... (or when I get around to it)
46. The New (Open Source) Stack
47. What can people do w/NYT APIs?
49. Fin
50. Questions?