11 Building a change workflow around API design-first

This chapter covers

  • Identifying the critical issues around an API design-first approach
  • Setting up a workflow to solve those issues using GitHub
  • Walking through an example change to our PetSitter API definition

Having defined an API, our next logical step is to start building it. When we do so, we will inevitably be missing something critical that will cause us pain down the road. We have to consider how changes to the API definition will be communicated when we’re not all in the same room—changes that result from issues found during implementation or evolving business requirements. Before we start implementing the code, we should take the time to set up a change workflow so that we’ll be ...

Get Designing APIs with Swagger and OpenAPI now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.