Automatic Documentation Generation on API Schema Sync

Ask the Experts and Postman Tips
, ,
1

Hi Postman team,

I have a working API Schema (OpenAPI) integration set up where my GitHub repo commits sync with a Postman API’s definition.

Is it possible to automatically update Postman Documentation associated with the API when the schema definition updates? It seems an API Documentation Collection needs to be manually generated to include the OpenAPI schema updates.

Regards,
Zhe

2

I’m considering hooking up a GitHub action to programmatically create a collection from schema if there’s no other automated way to do so via the schema update.

3

I ended up writing a Node CLI to do this as part of a BuildKite step instead of messing around with integrations.

1 Like
4

Glad to hear that :partying_face:

Leaving this screen-record here as a reference for other users looking for a solution, to also attempt this method to update existing collection/ documentation from the GitHub synced API.

5

The Node CLI is a great solution! But in my case, there are several of us updating the GitHub repo… Is there another way (or example GitHub action) that can PUT the update to Postman on commit?

Thanks!