Lukas Rosenstock's Blog

Lukas Rosenstock's Blog

Our book’s pre-release (MEAP) received two more updates since my last post. Now the missing chapters 18, 19, 20, and 21 for “Designing APIs with Swagger and OpenAPI” have been published as well. In chapters 18, 19, and 20, we’re looking at various advanced OpenAPI topics that help API designers refine their API definition and include as much machine-readable meta information as possible.

Chapter 18 is about filters, pagination, and sorting, topics of utmost importance for any API that provides access to an extensive dataset. Chapter 19 covers error handling. Finally, chapter 20 gives an excellent overview of the data validation capabilities of JSON schema that API providers can use for input validation. All three extend the PetSitter sample API that we use throughout the second and third parts of the book.

Our final chapter, 21, covers the next steps you have to take once you make a private or partner API available to the general public. We highlight the most critical API design issues and introduce the “API exposure index” as a way to decide and describe how much of your API you want to publish and which parts you want to keep private.

We’re getting closer and closer to the finish line. We only need to complete the final review and add the appendix(es). Then, the book enters production.

If you haven’t preordered the book yet, it’s a good time to do so. I am looking forward to your thoughts on these topics as well.