Philly CocoaHeads 20160414 - Building Your App SDK With Swift
Download as PPTX, PDF0 likes268 views
This document provides a summary of the steps taken to build an iOS SDK for the Supportify app over multiple iterations: 1. The initial SDK was created in Objective-C using a base framework but was difficult to implement and had code quality issues. 2. An updated SDK was created using Swift, but usability problems remained as it was still difficult for developers to implement. 3. Further iterations incorporated iOS design patterns like Clean Swift to reduce dependencies and modularize components. However, problems with the underlying API specification and tests emerged. 4. The final SDK version incorporated a Swagger-based proxy, models, authentication, and other improvements to address issues, resulting in a more full-featured and easier
Philly CocoaHeads 20160414 - Building Your App SDK With Swift
- 1. Building Your App SDK w/ Swift: A Soup to Nuts Guide Jordan Yaker @jordanyaker
- 3. State Of The Product (Spring 2015) •Mature Product •Few Client Libraries •Not Many Customers
- 4. Coming Up With A Plan
- 5. Libraries Created •.NET Nuget Package •Ruby Gem •PHP Composer Package •WordPress Plugin
- 6. Time For iOS •Learn Objective-C •tryobjectivec.codeschool.com •raywenderlich.com/category/ios •Build Base SDK •???
- 8. API Specification Frameworks •RAML •raml.org •API Blue-Print •apiblueprint.org •Swagger •swagger.io •Protocol Buffers •developers.google.com/protocol-buffers
- 9. Swagger Project •Swagger Specification •github.com/OAI/OpenAPI-Specification •Swagger Editor •editor.swagger.io •Swagger Codegen •github.com/swagger-api/swagger-codegen
- 10. Problems With That Swagger •Beware Of Authentication •Early Adopter Woes
- 11. Supportify Got Swagger (Fall 2015) •.NET Nuget Package •Ruby Gem •PHP Composer Package •Python Package •Java/Android Maven Package •Objective-C CocoaPod
- 12. 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.”
- 13. Swift: A Modern Language That’s Not Objective-C Code
- 14. 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
- 15. supportify-ios (1.0.0) •Swift •AlamoFire •supportify-ios/ releases/tag/1.0.0 Image Credit: theoatmeal.com
- 16. 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
- 18. iOS Has Lots Of Design Patterns Source: medium.com/ios-os-x-development/ios-architecture-patterns-ecba4c38de52
- 19. iOS Has Lots Of Design Patterns Source: medium.com/ios-os-x-development/ios-architecture-patterns-ecba4c38de52
- 20. iOS Has Lots Of Design Patterns Source: medium.com/ios-os-x-development/ios-architecture-patterns-ecba4c38de52
- 21. iOS Has Lots Of Design Patterns Source: medium.com/ios-os-x-development/ios-architecture-patterns-ecba4c38de52
- 22. Here Comes A New Challenger: Clean Swift
- 23. The Clean Swift Design Pattern Source: clean-swift.com/clean-swift-ios-architecture •Configurators Wire Everything Together •Controllers Talk To The Router •Everything Else Talks To The “Next” Thing
- 24. The Benefits •Reduced Interdependencies •Component Isolation •Fine-Grained Exposure •Easier Inheritance •Easier Implementation
- 25. Oh Look, More Problems
- 26. 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
- 27. 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 Tests Just Weren’t As Good We Thought
- 29. supportify-ios (3.1.2) •Swagger-Based Proxy •API Client •Resource Models •Global Configurator •Authentication •Global Filters •Scene Components •Category List •Entry List •Entry •Search List
- 30. But Wait – We’re Still Not Done
- 31. What Makes For Good Docs? •Copy And Paste •Simple To Complex •Good Structure
- 32. Questions?
Editor's Notes
- #3: 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.
- #4: This journey technically started in the Spring of 2015.
- #5: 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.
- #8: I remembered reading a couple of articles about API specification frameworks, so I dug in and did some research on the options.