{"id":15014081,"url":"https://github.com/alextanghk/postmantodocx","last_synced_at":"2025-04-11T11:04:40.426Z","repository":{"id":47233472,"uuid":"403539809","full_name":"alextanghk/PostmanToDocx","owner":"alextanghk","description":"Converting Postman collection(v2.1) Json file to word document(docx).","archived":false,"fork":false,"pushed_at":"2021-09-08T04:21:26.000Z","size":30,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-19T17:09:38.596Z","etag":null,"topics":["postman"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/alextanghk.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":"2021-09-06T08:14:48.000Z","updated_at":"2024-11-07T11:32:16.000Z","dependencies_parsed_at":"2022-09-07T16:32:28.386Z","dependency_job_id":null,"html_url":"https://github.com/alextanghk/PostmanToDocx","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alextanghk%2FPostmanToDocx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alextanghk%2FPostmanToDocx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alextanghk%2FPostmanToDocx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alextanghk%2FPostmanToDocx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alextanghk","download_url":"https://codeload.github.com/alextanghk/PostmanToDocx/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234669995,"owners_count":18869115,"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":["postman"],"created_at":"2024-09-24T19:45:10.009Z","updated_at":"2025-01-19T17:09:48.892Z","avatar_url":"https://github.com/alextanghk.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Convert Postman API Document Json\n\nConverting Postman collection Json file to MS Word document(docx).\n\n- [Description](#description)\n- [Environment](#environment)\n- [Supporting Schema](#supporting-schema)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Command](#command)\n\n\u003cbr /\u003e\n\n## Description\n\n\u003cbr /\u003e\n\nPostman is a very useful tool for API testing and documentation, however it didn't provide the option on exporting the API document to Word document, so I created my own module to serve this purpose. \n\n\n\u003cbr /\u003e\n\n## Environment\n\n\u003cbr /\u003e\n\nNode JS Version: 12 or above\n\n\u003cbr /\u003e\n\n## Supporting Schema\n\n\u003cbr /\u003e\n\n- https://schema.postman.com/collection/json/v2.0.0/draft-07/collection.json\n- https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json\n\n\u003cbr /\u003e\n\n## Installation \n````\n$ npm i postman-to-word -g // For cli\n$ npm i postman-to-word // For node project\n````\n\u003cbr /\u003e\n\n## Usage\nTo use this function in your code:\n\u003cbr /\u003e\n````\nconst postmanToDocx = require(\"postman-to-word\");\n\n// Promise return with true if success and throw Error when fail.\n// postmanToDocx(schema: string, source: string, [outputPath: string])\npostmanToDocx(\"2.1.0\",\"/Souces/API.json\",\"/Export\"); \n\n````\n\u003cbr /\u003e\n\n## Command\nYou can also use cli to convert the json to docx file.\n\u003cbr /\u003e\n````\n$ p2dx --sources=\u003cFULL_PATH_OF_JSON\u003e [--output=\u003cPATH_OF_OUTPUT_LOCATION\u003e, --schema=\u003cSCHEMA_VERSION\u003e]\nOptions:\n      --version  Show version number                                   [boolean]\n  -s, --source   Full path of the json file.                 [string] [required]\n  -o, --output   Output file path                         [string] [default: \"\"]\n  -c, --schema   Version of Postman Collection schema\n                         [string] [choices: \"2.1.0\", \"2.0.0\"] [default: \"2.1.0\"]\n  -h, --help     Show help                                             [boolean]\n\nExamples:\n  p2dx --source=/root/API.json          Export to same directory\n  p2dx --source=/root/API.json          Export to same directory with schema\n  --schema=2.1.0                        version\n  p2dx --source=/root/API.json          Export to other directory\n  --output=/Export/\n  p2dx --source=/root/API.json          Export to other directory with\n  --output=/Export/ --schema=2.1.0      schema version\n````\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falextanghk%2Fpostmantodocx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falextanghk%2Fpostmantodocx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falextanghk%2Fpostmantodocx/lists"}