Hi,
We have an API product, for which we have Swagger specification that gets generated from the source code.
I know I can then import that swagger spec in Postman to give me an initial version of the postman based documentation of that specific API.
I will then engage with my technical writer who will log into the postman and make several amendments / edits to that initially generated API documentation. He / she will add tables, add some business commentary, add introductions, additional pages to show key concepts etc.
Meanwhile the technical team will make further schema changes to few of the APIs, may add new endpoints etc, resulting in an updated version of the swagger spec.
However, I cannot simply import the newer version of the swagger spec, because there will be several manual changes done by the technical writer in that existing version of Postman documentation that I do not want to loose.
So, is there a way that I can keep importing an updated version of the swagger spec from the engineering team into Postman, while still also retaining changes to the existing documentation that were done by the technical writing team?
From my research so far, there does not seem to be a way to do that, and so my plan (unless any of you suggest to me a better approach), is to generate just the initial version of the swagger spec, import it into Postman, and then from thereon, stop generating updated swagger spec, and just keep on making all the subsequent changes done in the APIs manually and directly into Postman.
Do you think that is the right approach?