Building Your App SDK with Swift
Download as PPTX, PDF1 like438 views
The document is a comprehensive guide on building an application SDK using Swift, specifically tailored for the Supportify help-center service. It discusses various SDK iterations, the challenges faced in development, and the shift from Objective-C to Swift, while also addressing design patterns and the importance of documentation. Additionally, it highlights the improvements made from earlier versions to the final product, emphasizing usability and integration with existing systems.
Building Your App SDK with Swift
- 1. Building Your App SDK w/ Swift: A Soup to Nuts Guide Jordan Yaker @jordanyaker
- 2. FIS Global
- 3. Who is FIS? •Global Technology Consulting •The best and the brightest. •Emphasis on community. •And more…
- 5. What is Supportify? “It’s a help-center as as service that allows you to provide your users with instantaneous, always up-to-date help content. Keep your users happy with less effort using Supportify.”
- 6. What is was Supportify? “It’s a help-center as as service that allows you to provide your users with instantaneous, always up-to-date help content. Keep your users happy with less effort using Supportify.”
- 7. State Of The Product (Spring 2015) •Mature Product •Few Client Libraries •Not Many Customers
- 8. Coming Up With A Plan
- 9. Libraries Created •.NET Nuget Package •Ruby Gem •PHP Composer Package •WordPress Plugin
- 10. Time For iOS •Learn Objective-C •tryobjectivec.codeschool.com •raywenderlich.com/category/ios •Build Base SDK •???
- 11. Get Some Swagger
- 12. API Specification Frameworks •RAML •raml.org •API Blue-Print •apiblueprint.org •Swagger •swagger.io •Protocol Buffers •developers.google.com/protocol-buffers
- 13. Swagger Project •Swagger Specification (Open API Initiative) •github.com/OAI/OpenAPI-Specification •Swagger Editor •editor.swagger.io •Swagger Codegen •github.com/swagger-api/swagger-codegen
- 14. Problems With That Swagger •Beware Of Authentication •Early Adopter Woes •Security • Be careful what you share with others. • Exploitation • “…a malicious Swagger definition document…” Source: https://community.rapid7.com/community/infosec/blog/2016/06/23/r7-2016-06- remote-code-execution-via-swagger-parameter-injection-cve-2016-5641
- 15. Stop . . . Demo Time
- 16. Supportify Got Swagger (Fall 2015) •.NET Nuget Package •Ruby Gem •PHP Composer Package •Python Package •Java/Android Maven Package •Objective-C CocoaPod
- 17. supportify-ios (1.0.0.beta) •Objective-C •AFNetworking •Erased From History •That’s a good thing. •“Sick code, bro. No really I think it’s contagious. I feel sick just from looking at it.”
- 18. Swift: A Modern Language That’s Not Objective-C Code
- 19. Time For iOS (Again) •Learn Objective-C •Build Base SDK •Learn Swift •Code School: Swift Live Part 1 / Part 2 •raywenderlich.com/category/swift •github.com/raywenderlich/swift-style-guide •developer.apple.com/swift •Build Base SDK
- 20. supportify-ios (1.0.0) •Swift •AlamoFire •supportify-ios/ releases/tag/1.0.0 Image Credit: theoatmeal.com
- 21. Why Was The SDK Still Terrible? “You’re telling me that this is going to save me time, but I have to jump through all of these hoops to implement it? I’ve already got enough to do on a regular basis. F*ck that. Give me an easy to implement solution that gives me no aggravation, man.” - Nate Bomberger
- 23. iOS Has Lots Of Design Patterns Source: medium.com/ios-os-x-development/ios-architecture-patterns-ecba4c38de52
- 24. iOS Has Lots Of Design Patterns Source: medium.com/ios-os-x-development/ios-architecture-patterns-ecba4c38de52
- 25. iOS Has Lots Of Design Patterns Source: medium.com/ios-os-x-development/ios-architecture-patterns-ecba4c38de52
- 26. iOS Has Lots Of Design Patterns Source: medium.com/ios-os-x-development/ios-architecture-patterns-ecba4c38de52
- 27. Here Comes A New Challenger: Clean Swift
- 28. The Clean Swift Design Pattern Source: clean-swift.com/clean-swift-ios-architecture •Everything Talks To The “Next” Thing •Configurators Wire Everything Together •Controllers Talk To The Router •Models Transport Data
- 29. The Benefits •Reduced Interdependencies •Component Isolation •Fine-Grained Exposure •Greater Testability •Easier Inheritance •Easier Implementation
- 30. Oh Look, More Problems
- 31. I Got 99 Problems & Swagger Is One •No Passing Of Server Errors •No Parsing Of Server-Returned Error Objects •AlamoFire Demands Data With 200 Status •The API Wasn’t Using 204 Status Codes
- 32. The API Needed Some Tweaks •Tag And Category Filtering •CSV (“Tag 1, Tag 2, Tag 3”) •Rudimentary DSL (“Tag 1 AND (Tag 2 OR Tag 3)”) •The “Order” Parameter •…and the server unit tests just weren’t as good we thought.
- 34. supportify-ios (3.1.2) •Swagger-Based Proxy •API Client •Resource Models •Global Configurator •Authentication •Global Filters •Scene Components •Help Center • Category List • Entry List • Entry • Search List •About Us Page •Tooltip •Onboarding/Wizard
- 35. supportify-ios (3.1.X) •More Components •About Us / Single Content Pages •Tooltip / Popups •Onboarding / Wizards
- 36. But Wait – We’re Still Not Done
- 37. What Makes For Good Docs? •Copy And Paste •Simple To Complex •Good Structure
- 38. Questions?
Editor's Notes
- #4: This journey technically started in the Spring of 2015.
- #5: I started this journey because of my product: Supportify. Supportify is a SaaS product focused on allowing apps to instantly provide users with dynamic help where, when, and how they need it. Whether it’s a help center, tool tips, or knowledge base, you simply implement once and you content remains always up to date.
- #6: This journey technically started in the Spring of 2015.
- #7: This journey technically started in the Spring of 2015.
- #8: This journey technically started in the Spring of 2015.
- #9: It was clear that a shift in focus was needed. Conversations with fellow entrepreneurs made it clear that the next step was to beef up the client libraries and reduce the LOE for implementation.
- #12: I remembered reading a couple of articles about API specification frameworks, so I dug in and did some research on the options.
- #16: I remembered reading a couple of articles about API specification frameworks, so I dug in and did some research on the options.