Building an API client library for a third-party service with incomplete documentation while maintaining schema-driven development principles is a challenging circular dependency problem. Here’s a comprehensive approach to navigate this complexity systematically.
Contents
Core Challenge
One of the more common development patterns in modern web development and software engineering is the need to integrate with third party APIs. In order to best do this, developers and engineers attempting to implement schema-driven development patterns rely on a complete, comprehensive OpenAPI Specification to bootstrap their project. When a specification is not available or is incomplete or invalid, the developer must reverse engineer the various schemas and endpoints through a very intricate process. This creates inherent tension between the ideal of API First Development and the reality of incomplete third-party documentation and specifications.