In the first part of this book, we went through the basics of APIs, how to use them, and how to formally describe them with OpenAPI. We also worked with Swagger Editor to document an existing API—the FarmStall API—using OpenAPI. Now, in the second part of this book, we’ll design a new API for a web application from scratch.
Going through the API design process and further through the API lifecycle is not just about using OpenAPI and various tools. It’s also about people and processes. There are always new requirements and unforeseen circumstances that require handling. We’ve tried to make this second part of the book as close to reality as possible by working through the process with a fictional company.
We’ll start with a founder envisioning an idea and assembling a team. Together they’ll create a plan to realize the project that starts with a domain model and user stories, continues with API design, and finishes with software implementation and integration. We’ll explain these methods as we move through the process.