Part 2 Design-first

 

Part 2 starts afresh by introducing a new product, with the goal of designing its API from scratch, instead of documenting an existing one as we did in part 1.

We’ll work with a fictional software product for pet owners who need to hire pet sitters to look after their companions when they’re away—we’ve given it the incredibly original name PetSitter. This scenario provides the background theme for the remainder of the book. We’ll also introduce the company and three personas that will help us capture the driving roles behind an API’s design process. The technical stack for PetSitter is split into a backend (the server) and a frontend (the website) that communicate via the API.

This part of the book opens up with defining the requirements, looking at user stories, and domain modeling (chapter 9). It progresses by taking those models and designing an API using OpenAPI (chapter 10). Topics in the design process include change workflow (chapter 11), mocking with Prism (chapter 12), generating server stubs with Swagger Codegen (chapter 13), and integrating the two components together into a working system (chapter 14).

Each chapter builds on the last, so we recommend that these chapters be read in sequence.