Keeping your APIs Honest - Gluecon 2017

Ever had your API documentation go out of sync with your API implementation? Or broke API clients with a refactor of your back-end code? Or maybe you deployed the wrong version of a microservice to production instead of staging... If the above sends chills down your spine, then this talk is for you! We'll learn how to use open source tooling to test your code against an API spec, during development or in production, so you can ensure your documentation is in sync and that you don't break everyone out there that depends on your API.

Transcript

1. Emmanuel Paraskakis @manp Keeping Your APIs Honest
2. Apiary + 365,901 APIs 3M+ Consumers 272,634 Designers Full API Lifecycle
3. Design-First Design Prototype Implement Deploy Feedback
4. “This is the story of how a company with nearly $400 million in assets went bankrupt in 45-minutes because of a failed deployment”
5. API Deployments • Have I implemented what was agreed? • Have I deployed the right thing - to the right env? • Does my API Documentation describe what I just deployed? • Am I introducing breaking changes to my (non- evolvable) clients?
6. • Contract • Documentation • “How the API should behave” • Executable Specification, by Example API Description
7. Test against the API Description API Description Live API Test Fails Test Passes
9. Dredd is Mature
10. Dredd is Open Sourced Adam Kliment Honza Javorek
11. Dredd is Community-Driven
12. Dredd is a CLI tool $ npm install -g dredd $ dredd init $ dredd
13. What You Can Do: 1. Try Dredd out:
 dredd.readthedocs.io 2. Meet us at our booth:
 Across from this room 3. Win Snap Spectacles!
 Complete your Passport card