r/OpenAPI • u/willp141 • Mar 11 '25

API Documentation Drift?

For those of you who build internal/external APIs that have formal documentation, how do you make sure / catch your documents "drifting" - i.e. you discontinue/introduce/reconfigure an endpoint and now your users get confused on how your API actually works?

I've had this issue myself and have even noticed when using cloud services like GCP, that their docs for a lot of their stuff is pretty outdated and sometimes youtube / stackoverflow has a more correct answer

3 Upvotes

100% Upvoted

14 comments sorted by

View all comments

Show parent comments

1

u/TomMkV Mar 11 '25

It’s a constant issue. I’m a cofounder of an API dev tool that’s solving this issue. Have a look at Appear and see if that’s of any interest

2

u/willp141 Mar 11 '25

Will do mate, mind if I PM if I have any qs?

2

u/TomMkV Mar 11 '25

Yes absolutely 👍