{"id":13471867,"url":"https://github.com/PhillippOhlandt/pmtoapib","last_synced_at":"2025-03-26T15:30:43.876Z","repository":{"id":65695771,"uuid":"84063069","full_name":"PhillippOhlandt/pmtoapib","owner":"PhillippOhlandt","description":"Tool to convert Postman collection exports to Api Blueprint documentation","archived":false,"fork":false,"pushed_at":"2018-01-17T17:01:37.000Z","size":49,"stargazers_count":37,"open_issues_count":3,"forks_count":2,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-07-03T12:08:21.299Z","etag":null,"topics":["api-blueprint","postman","postman-collection","postman-export"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PhillippOhlandt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-06T11:00:08.000Z","updated_at":"2023-09-17T18:53:26.000Z","dependencies_parsed_at":"2023-02-05T00:35:17.078Z","dependency_job_id":null,"html_url":"https://github.com/PhillippOhlandt/pmtoapib","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PhillippOhlandt%2Fpmtoapib","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PhillippOhlandt%2Fpmtoapib/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PhillippOhlandt%2Fpmtoapib/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PhillippOhlandt%2Fpmtoapib/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PhillippOhlandt","download_url":"https://codeload.github.com/PhillippOhlandt/pmtoapib/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":213381279,"owners_count":15578524,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-blueprint","postman","postman-collection","postman-export"],"created_at":"2024-07-31T16:00:49.914Z","updated_at":"2024-07-31T16:08:02.349Z","avatar_url":"https://github.com/PhillippOhlandt.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# Postman to Api Blueprint Converter\n\nA simple tool to convert Postman collection exports (**v2**) to Api Blueprint documentation.\n\nNotice: It uses the [Aglio](https://github.com/danielgtaylor/aglio) include syntax!\n\n## Usage\n\nAssuming that `collection.json` is your Postman collection export.\n\n```\npmtoapib -collection collection.json -destination docs\n```\n\nThe `docs` folder will be created with the following content\n\n```\n├── collection-name.apib\n└── responses\n    ├── get-200-me.json\n    ├── get-200-users.json\n    ├── post-200-me.json\n    └── users\n        ├── get-200_userID_2-2.json\n        └── get-404_userID_1-2.json\n```\n\nThe `responses` folder contains JSON files with the (pretty printed) response bodies.\nIf a request has no exported responses (e.g. you didn't save any in Postman), \nthe response file will contain an empty JSON object.\n\nThe folders inside the `responses` folder line up with the request paths and\nthe files are named with the following pattern: `{method}-{response name}-{last element in url}.json`.\n\nBy default, the collection name will be used as the `.apib` filename.\nIt can be overridden with the `-apibname` parameter.\n\n```\npmtoapib -collection collection.json -destination docs -apibname users\n```\n\nThis will generate a `users.apib` file.\n\n## Usage with Docker\n\nYou can also use the Docker image if you don't use Mac OS and don't want to compile it on your own.\n\n```\ndocker run --rm -it -v \"$PWD:/opt\" phillippohlandt/pmtoapib -collection collection.json -destination docs\n```\n\n## Command Line Flags\n\n| Command | Short Version | Type | Default Value | Description |\n|---------|---------------|------|---------------|-------------|\n| -collection | -c | string | | Path to the Postman collection export |\n| -destination | -d | string | `./` | Destination folder path for the generated files |\n| -apibname | | string | | Set a custom name for the generated .apib file |\n| -force-apib | | boolean | `false` | Override existing .apib files |\n| -force-responses | | boolean | `false` | Override existing response files |\n| -dump-request | | string | | Output the markup for a single request (Takes a request name) |\n\n\n## Options\n\n### Exclude Requests\n\nTo exclude a whole request from the generated `.apib` file, simply put the string `pmtoapib_exclude` \nin the request description. It will also prevent the generation of the response files for that request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPhillippOhlandt%2Fpmtoapib","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPhillippOhlandt%2Fpmtoapib","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPhillippOhlandt%2Fpmtoapib/lists"}