With a large vendor API, how much do teams typically implement? I'm also curious how people split the work, keep a shared understanding of the docs, and catch changes later.
Do you usually integrate with a few vendor API endpoints or most of them?
Answers
Start with the operations your feature actually needs. A big API can be tempting to wrap in full, but every unused method and type is still code someone has to maintain.
A thin adapter or service class can expose your own domain operations and translate the vendor's data and errors at the boundary. Add more calls when a real requirement comes up. That also gives you one place to adjust if the vendor changes a response.
Reply to this answer
Even if you only need a handful of endpoints, read the shared parts carefully. Authentication, rate limits, and error formats can affect every call. Endpoint count alone doesn't tell you how much documentation you need to understand.
Reply to this answer
If the vendor provides an OpenAPI specification, generating a client can save work on types and request validation. That doesn't automatically make the vendor interface a good one for the rest of your application, though. You can still put a smaller interface around the generated client and expose only what you use.
Reply to this answer
For a larger integration, I'd keep a short mapping note for each area of work. Record the endpoint, what it means in your domain, and any assumptions the implementation relies on. People can divide up sections without having to rely on one person remembering every detail of a long PDF.
Reply to this answer
Scheduled tests against the vendor integration can help catch changes that weren't communicated, including renamed fields. They won't catch everything, so focus them on the operations and response fields your application actually depends on.
Reply to this answer
Add your answer
Answers are reviewed before publication.
c.827!gromnix:
Some teams might still document common operations as unsupported placeholders. That can make the intended surface visible without pretending those calls are ready to use.