https://github.com/jumaevkova/openapi2postman

Update Postman collection from openapi file
https://github.com/jumaevkova/openapi2postman

golang-package marketplace openapi openapi3 postman postman-collection postman-documentation swagger swagger2

Last synced: about 2 months ago
JSON representation

Update Postman collection from openapi file

• Host: GitHub
• URL: https://github.com/jumaevkova/openapi2postman
• Owner: jumaevkova
• Created: 2023-11-01T15:33:20.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-07-31T12:54:36.000Z (11 months ago)
• Last Synced: 2025-09-04T16:38:55.722Z (10 months ago)
• Topics: golang-package, marketplace, openapi, openapi3, postman, postman-collection, postman-documentation, swagger, swagger2
• Language: Go
• Homepage:
• Size: 14.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# openapi2postman action

GitHub action to push openapi (OpenAPI 3.0, 3.1 and Swagger 2.0) file to Postman directly from your workflow

## Usage

Add the openapi2postman action and set the required inputs

* `api-key`: your Postman API key

* `workspace-id`: your Postman workspace id

* `collection-id`: your Postman collection id

* `file`: your openapi json file

### File formats available

`.json`   

`.yaml`   

`.yml`

### Update existing collection

Update existing Postman collection

```yaml

    - name: "Update Postman Collection"

      uses: jumaevkova/openapi2postman@main

      with:

        api-key: ${{ secrets.POSTMAN_API_KEY }}

        workspace-id: ${{ secrets.POSTMAN_WORKSPACE_ID }}

        collection-id: ${{ secrets.POSTMAN_COLLECTION_ID }}

        file: ./docs/swagger.json

```

### Example workflow file

Update Postman collections on `push`

```yaml

name: "Update Postman collection"

on:

  push:

    branches: [ "main" ]

jobs:

  sync-documentation-with-postman:

    runs-on: ubuntu-latest

    steps:

      - name: "Checkout repository"

        uses: actions/checkout@v3

      - name: "Update Postman Collection"

        uses: jumaevkova/openapi2postman@main

        with:

          api-key: ${{ secrets.POSTMAN_API_KEY }}

          workspace-id: ${{ secrets.POSTMAN_WORKSPACE_ID }}

          collection-id: ${{ secrets.POSTMAN_COLLECTION_ID }}

          file: ./docs/swagger.json

```