5 API design review: Checking for what you cannot automate

This chapter covers

  • Understanding what an API review is
  • Running an API review
  • Measuring review effectiveness

Imagine you’ve created a new API, and your API definition file has passed all the automated commit stage checks in your continuous integration/continuous delivery (CI/CD) pipeline. You raise a pull request (PR) to get your change merged to the main branch of your API definition project. Is there still a need to get your colleagues to review the API definition change in your PR? Yes, there is. Reviewing an API change proposal with colleagues and even prospective users enables you to get feedback that the automation can’t provide. It’s also an opportunity to review the reports ...

Get Automating API Delivery now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.