AI-Driven API Design

Part I. Preparation

A Note for Early Release Readers

With Early Release ebooks, you get books in their earliest form—the author’s raw and unedited content as they write—so you can take advantage of these technologies long before the official release of these titles.

This will be Part I of the final book. Please note that the GitHub repo will be made active later on.

If you’d like to be actively involved in reviewing and commenting on this draft, please reach out to the editor at [e-mail].

Vignette to come.

Figure I-1. Image to come

Preparation is the most important work when setting out to achieve a goal. Honing our skills, gathering tools, and making plans for the journey are all requirements for success. Unfortunately, this initial work is not often exciting or glamorous. In most movies, for example, we see preparation rendered as a montage of various scenes accompanied by an inspiring music track; all without any substantial dialogue.

But, in real life, there is no montage; just lots of research and practice. And that’s what we’ll be doing in Part I of this book. We’ll cover the foundational “discovery” work required to identify the key domain topics your APIs must address and develop personas for the various users who will consume them. These will help us better recognize and fulfill the stated needs of the API.

We’ll also spend time gathering a set of project-level ...