Verantwortungsvolle APIs

Als wir 2013 begannen, an shipcloud zu arbeiten, hatten wir noch keine Ahnung, welche Verantwortung man als API-Provider eingeht. Je mehr Kunden unser API im Livebetrieb einsetzten, um so mehr wurden wir uns dieser Bedeutung klar. Welche Auswirkungen ein Ausfall haben kann, merkten wir aber erst, als wir selbst live und in Farbe miterleben mussten, wie eins der für uns wichtigen APIs von einen auf den anderen Tag wegzufallen drohte, weil der Betreiber es schließen wollte. Anfang 2015 befanden wir uns in einer ähnlichen Situation und mussten einen Notfallplan entwickeln, mit dem wir einen minimalen Betrieb aufrecht erhalten könnten und möglichst wenig Kunden verärgern würden. Dieser Vortrag soll einen Einblick darin geben, welche Verantwortung wir als Softwareentwickler heutzutage haben. Es reicht einfach nicht mehr, sich nach vollendeter Arbeit auf seinen Lorbeeren auszuruhen, wenn Kunden unsere Arbeit im Livebetrieb nutzen.

Transcript

1. Verantwortungsvolle APIs
2. André Cedik Developer Advocate & Software Developer shipcloud GmbH @andrecedik
3. The road so far
4. Shitstorm Incoming
5. Breaking Change • macht Euch der Implikationen bewusst, die Eure Entscheidungen haben • auch kleine Änderungen können große Auswirkungen haben
6. Jumping Through Hoops • Änderungen klar kommunizieren • zusätzliche Hürden (z.B. Freischaltung) beseitigen
7. Code Qualität
8. Default-Werte • API muss eindeutig sein • Fallbacks vermeiden • keine Seiteneffekte
9. Konsistenz erreichen • frühzeitig Edge Cases identifizieren • API-Nutzer vor Seiteneffekten externer Schnittstellen schützen
10. Feed your own dogfood • API auch in Browser-Applikation nutzen (sofern angeboten) • Side Projects auf Basis der eigenen Lösung
11. Ship it! • Release often & early • Feature Toggles nutzen • Pre-Release Code in kleinen Teilen
12. Get Feedback • VIP-Kunden identifizieren und für Test von neuen Features einbinden • Tinker in Side Projects & Hackathons
13. Frühzeitig Gedanken 
 über v2 machen • Übersichtlichkeit erreichen • Kommunikation gegenüber Partnern & Kunden erarbeiten
14. Gute Dokumentation • Swagger, RAML, etc. • In-Code-Doku (z.B. über Annotationen) • Documentation Driven Design • OpenSource • Changelog pflegen
15. Spread the love
16. Affiliate Programme • auf Monetarisierung achten • nachhaltige Incentives schaffen
17. Offenheit • Statusseite • Downtimes / Maintenance • Weiterverteilung über Zielgruppen spezifische Kanäle
18. Vorlaufzeit für Integrationspartner • in Roadmap einbinden • mit nötigen Rechten versorgen • ggf. gemeinsames Marketing betreiben
19. Make it easy • einfache API, ohne Seiteneffekte / Sonderlocken • gute Dokumentation • offen / ansprechbar sein
20. "APIs are a long commitment. Once you build them, they take time for developers to adopt and grow into revenue. You don’t put your enterprise sales team in the field and start closing $10M deals on launch day. You seed developers with ideas, you help them find use cases, and after developers build, you watch their apps go from prototypes, to betas, to production systems with happy customers. It requires patience and deep commitment, but when developers succeed with your API, you succeed." Jeff Lawson Twilio CEO & Co-Founder
21. André Cedik Developer Advocate & Software Developer