October 15-17 | Vancouver, British Columbia
View More Details  & Register Here
Back To Schedule
Thursday, October 17 • 11:00am - 11:30am
The Perfect API Description Workflow - Phil Sturgeon, Stoplight

Sign up or log in to save this to your schedule, view media, leave feedback and see who's attending!

Feedback form is now closed.
API Description Documents (a.k.a "specifications") revolutionize every phase of the API
lifecycle, but a lot of people struggle to figure out their workflows. How to integrate all the things, and what format to use when.

- Use beautiful GUI designers to get started planning your API before any code gets written
- Create mocks from those descriptions and share em around to get feedback before you waste any time coding
- Implement Spectral to enforce a style guide for your descriptions so they can be high quality
- Do everything in git so once mock gets a thumbs up, there is a papertrail for any big changes
- Use those descriptions as contract tests as you develop to make sure you're coding it right
- Use the descriptions to power your HTTP request validation to avoid rewriting all that stuff
- Spit out the descriptions as docs for anyone who needs them

avatar for Phil Sturgeon

Phil Sturgeon

Chief Architect, Stoplight
Phil Sturgeon has been building APIs professionally since 2010. He’s worked as API/architectural consultant for all sorts of companies, from small startups to WeWork. He wrote about a lot of that in Build APIs You Won’t Hate, and grew a community around that into the largest API-related... Read More →

Thursday October 17, 2019 11:00am - 11:30am PDT
Pavilion Ballroom