Hello Postman Community,
Our use case is the following: We’d like our partners to be able to access our API documentation seamlessly. To achieve this, we aim to automate the creation of new versions of the documentation directly from an OpenAPI spec file as part of our CI/CD pipeline.
We are looking for advice on best practices, and workflows that can help us accomplish this. Specifically, we want to:
Ensure our API docs are always up-to-date and accessible to partners.
Integrate the documentation generation process into our CI/CD pipeline.
Utilize OpenAPI spec files to automate the creation of new documentation versions.
So far we’ve looked at:
1.Creating an API and then using the schema update endpoint, and possibly the create version endpoint
-
Using the collection import endpoint, but that doesn’t seem to support versioning, in the sense that a new collection gets created on every call.
-
Converting the OpenAPI file to a postman collection and updating an existing collection’s contents using the API like
Pushing OpenAPI files to Postman. Seamless integration with a GitHub… | by Beppe Catanese | Medium
Any insights, recommendations, or examples from your experiences would be greatly appreciated!
Thank you in advance for your help,
Alvaro