Use and Re-use of API Description Languages in the Design Lifecycle

Apiary APIStrat Un-Workshops at Gluecon 2015 Presentation on API Design demonstrating Hyperdrive runtime hypermedia client.

Transcript

1. Use and Re-use API Description Languages and the Design Lifecycle
2. It’s All About… • Structured Data • API Semantics, Metadata, Protocols, and Annotation • Tooling
3. Design Lifecycle • Design First (?) • Collaborative Prototyping (realtime mocking) • Automated Design and Style Validation • Code Generation • Parallel Client/Server Implementation with TDD/BDD/CI • Interactive Documentation (validated in CI) • Monitoring and Discovery
4. API Evolvability
5. Traditionally Design and Consume APIs around Implementation Details
8. What if we could … • Change implementation details • Add new features • Remove features • Move fast And not break things!
9. Hyperdrive
10. Representor Pattern
11. Teach Clients the Semantic Meaning of a Domain
12. Don’t Hard-code Implementation Details
13. hyperdrive(apiary: “pollsapi") hyperdrive(blueprint: “https://polls.apiblueprint.org/") hyperdrive.enter("https://polls.apiblueprint.org/") { result in // Explore API feature availability }
14. if let questions = representor.transitions["questions"] { // The API offered us a link to questions } else { // Gracefully handle when this feature is missing }
15. if let create = representor.transitions["create"] { // API supports creation } else { // Feature is missing // Let's not show the create button in our UI }
16. Demo
17. https://github.com/the-hypermedia-project/Hyperdrive https://github.com/apiaryio/polls-app https://github.com/apiaryio/polls-api https://github.com/the-hypermedia-project/representor-swift http://cocoadocs.org/docsets/Representor/0.5.0/ Mark W. Foster mark@apiary.io @fosrias