15 The API Design First approach

This chapter covers

Going over the material we covered in part two
Highlighting why certain decisions were made in José’s API Design First approach
Touching up when a design is complete

The PetSitter project was accomplished by using an API Design First approach where we used the design as the central driving force to move the project forward. In this chapter we are going to revisit the decisions that helped us get there and set a standard for designing APIs in the future.

In part two we went over the following chapters…

9 Designing a web application
10 Creating an API design using OpenAPI
11 Building a change workflow around API Design First
12 Implementing frontend code and reacting to changes.
13 Building a Backend with Node.js and Swagger Codegen
14 Integrating and releasing the web application

Figure 15.1. Steps in an API Design First approach

Each chapter covered a part of the API Design First approach. From designing the domain models to tying together the implemented code. They were all in aide of using the design to push the project forward.

15 The API Design First approach

This chapter covers

Figure 15.1. Steps in an API Design First approach

15.1 Choosing the constraints

15.2 Creating the first design

15.3 Creating the OpenAPI definition

15.4 Keeping the code and design in sync

15.4.1 Keeping the design in sync with code

15.4.2 Keeping the code in sync with the design

15.5 Dealing with the real world

15.6 When a design is complete

15.7 Summary