API Design Lifecycle

Collaborating to Build Great APIs

Transcript

1. API Design Lifecycle Collaborating to Build Great APIs
2. – Leslie Lamport “I believe that the best way to get better programs is to teach programmers how to think better.”
3. Architecture is related to a set of (self- imposed) constraints that produce a set of favorable properties of a system
4. Design First • Include variety of stakeholders • Top-down vs. bottom-up • Develop good designs early • Re-usable description format as contract • Write less code
5. The best design of an API is not a particular paradigm or architecture – it is a design where everybody at the table agreed on what the API is/will be.
6. Prototyping • Collaborative • Realtime mocking • Code Generation
7. Implementation • Parallel Client/Server Development • TDD/BDD/CI Integration
8. Documentation • Auto-generated • Interactive • Validated in CI
9. Monitoring • Post-deployment Smoke Testing • Debugging • Inspection
10. Mark W. Foster mark@apiary.io @fosrias @apiaryio We’re Hiring! http://docs.pollsdemoapi.apiary.io