OrdaSoft forum
Welcome, Guest
Please Login or Register.    Lost Password?
Issues documenting fast-changing third-party apis (0 viewing) 

Joomla Social Comments and Sharing

Go to bottom Favoured: 0

Issues documenting fast-changing third-party apis

Mei (User)
Fresh Boarder
Posts: 1
graphgraph
User Offline Click here to see the profile of this user
Issues documenting fast-changing third-party apis 6 Hours, 55 Minutes ago
Karma: 0  
Hi everyone,

I’m running into a problem when trying to document apis in stoplight that come from tools or platforms that update their endpoints very frequently. I’ve been testing this with an api I consume through something called delta execute, and what keeps happening is that the schema I define in stoplight goes out of sync almost immediately when the api adds or modifies routes.

The biggest pain point is that stoplight’s validation and mocking start to fail because the openapi spec no longer matches what the api is actually returning. That leads to broken mocks, failing examples, and sometimes confusing errors for people who are using the documentation.

I’m wondering how others handle situations like this. Is there a recommended workflow in stoplight for apis that don’t have a stable contract or that change responses and parameters without much notice? Do people usually version aggressively, use schema diffs, or rely on some kind of automated import to keep things in sync?

I’d really like to keep my stoplight project usable and accurate, but with apis that evolve quickly, it’s been harder than expected.

Thanks in advance for any guidance.
Logged Logged
The administrator has disabled public write access.
Go to top
»