{"id":15600409,"url":"https://github.com/jason-fox/fox.jason.passthrough.postman","last_synced_at":"2025-04-24T07:17:03.611Z","repository":{"id":54682423,"uuid":"199714458","full_name":"jason-fox/fox.jason.passthrough.postman","owner":"jason-fox","description":"Generate DITA-based REST API documentation from a Postman collection added directly to a ditamap","archived":false,"fork":false,"pushed_at":"2024-02-18T07:38:11.000Z","size":536,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-24T07:16:56.885Z","etag":null,"topics":["dita","dita-ot-plugin","postman","postman-collection","rest-api"],"latest_commit_sha":null,"homepage":"https://jason-fox.github.io/dita-ot-plugins/postman","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jason-fox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-30T19:26:49.000Z","updated_at":"2024-12-20T16:35:45.000Z","dependencies_parsed_at":"2025-03-07T16:33:04.748Z","dependency_job_id":"abe6c5a7-f27e-4ac5-b892-9e9916ee6b92","html_url":"https://github.com/jason-fox/fox.jason.passthrough.postman","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jason-fox%2Ffox.jason.passthrough.postman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jason-fox%2Ffox.jason.passthrough.postman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jason-fox%2Ffox.jason.passthrough.postman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jason-fox%2Ffox.jason.passthrough.postman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jason-fox","download_url":"https://codeload.github.com/jason-fox/fox.jason.passthrough.postman/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250580756,"owners_count":21453538,"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":["dita","dita-ot-plugin","postman","postman-collection","rest-api"],"created_at":"2024-10-03T02:02:46.587Z","updated_at":"2025-04-24T07:17:03.587Z","avatar_url":"https://github.com/jason-fox.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Postman Plugin for DITA-OT [\u003cimg src=\"https://jason-fox.github.io/fox.jason.passthrough.postman/postman.png\" align=\"right\" width=\"300\"\u003e](http://postmandita-ot.rtfd.io/)\n\n[![license](https://img.shields.io/github/license/jason-fox/fox.jason.passthrough.postman.svg)](http://www.apache.org/licenses/LICENSE-2.0)\n[![DITA-OT 4.2](https://img.shields.io/badge/DITA--OT-4.2-green.svg)](http://www.dita-ot.org/4.2)\n[![CI](https://github.com/jason-fox/fox.jason.passthrough.postman/workflows/CI/badge.svg)](https://github.com/jason-fox/fox.jason.passthrough.postman/actions?query=workflow%3ACI)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fox.jason.passthrough.postman\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=fox.jason.passthrough.postman)\n\nThis is a [DITA-OT Plug-in](https://www.dita-ot.org/plugins) used to auto-create valid DITA-based REST API\ndocumentation. The documentation can be generated directly from a [Postman Collection](https://www.getpostman.com/) file\nand processed as if it had been written in DITA.\n\n:arrow_forward: [Video from DITA-OT Day 2019](https://youtu.be/cd7XThpkivw)\n\n[![](https://jason-fox.github.io/fox.jason.passthrough.postman/nothing-video.png)](https://youtu.be/cd7XThpkivw)\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eTable of Contents\u003c/strong\u003e\u003c/summary\u003e\n\n-   [Background](#background)\n-   [Install](#install)\n    -   [Installing DITA-OT](#installing-dita-ot)\n    -   [Installing the Plug-in](#installing-the-plug-in)\n    -   [Installing Pandoc](#installing-pandoc)\n-   [Usage](#usage)\n-   [License](#license)\n\n\u003c/details\u003e\n\n## Background\n\n[\u003cimg src=\"https://assets.getpostman.com/common-share/postman-logo-horizontal-orange.svg\" align=\"right\" height=\"55\"\u003e](https://www.getpostman.com/)\n\n[Postman](https://www.getpostman.com/) is a software development tool which a developer can use to build, publish,\ndocument, design, monitor, test and debug their REST APIs.\n\nThis plugin processes a Postman collection to Pandoc markdown, and the converts the markdown to DITA using the\n[Pandoc DITA-OT Plugin](https://github.com/jason-fox/fox.jason.passthrough.pandoc) allowing the generation of PDF API\ndocumentation.\n\n#### Sample Postman Request\n\n```json\n{\n    \"name\": \"Obtain Entity Data by id\",\n    \"request\": {\n        \"method\": \"GET\",\n        \"header\": [],\n        \"url\": {\n            \"raw\": \"http://{{orion}}/v2/entities/urn:ngsi-ld:Store:001?options=keyValues\",\n            \"protocol\": \"http\",\n            \"host\": [\"{{orion}}\"],\n            \"path\": [\"v2\", \"entities\", \"urn:ngsi-ld:Store:001\"],\n            \"query\": [\n                {\n                    \"key\": \"options\",\n                    \"value\": \"keyValues\",\n                    \"description\": \"* `keyValues` option in order to get a more compact ...\"\n                },\n                {\n                    \"key\": \"type\",\n                    \"value\": \"Store\",\n                    \"disabled\": true,\n                    \"description\": \"Entity type, to avoid ambiguity in case there are ...\"\n                },\n                {\n                    \"key\": \"attrs\",\n                    \"value\": \"name\",\n                    \"disabled\": true,\n                    \"description\": \"Ordered list of attribute names to display\"\n                }\n            ]\n        },\n        \"description\": \"This example returns the context data of `store1`...\"\n    },\n    \"response\": []\n}\n```\n\n#### Sample DITA Output\n\n\u003e ![](https://jason-fox.github.io/fox.jason.passthrough.postman/request-formatted.png)\n\n## Install\n\nThe DITA-OT postman plug-in has been tested against [DITA-OT 3.x](http://www.dita-ot.org/download). It is recommended\nthat you upgrade to the latest version.\n\n### Installing DITA-OT\n\n\u003ca href=\"https://www.dita-ot.org\"\u003e\u003cimg src=\"https://www.dita-ot.org/images/dita-ot-logo.svg\" align=\"right\" height=\"55\"\u003e\u003c/a\u003e\n\nThe DITA-OT postman plug-in is a file reader for the DITA Open Toolkit.\n\n-   Full installation instructions for downloading DITA-OT can be found\n    [here](https://www.dita-ot.org/4.0/topics/installing-client.html).\n\n    1.  Download the `dita-ot-4.2.zip` package from the project website at\n        [dita-ot.org/download](https://www.dita-ot.org/download)\n    2.  Extract the contents of the package to the directory where you want to install DITA-OT.\n    3.  **Optional**: Add the absolute path for the `bin` directory to the _PATH_ system variable.\n\n    This defines the necessary environment variable to run the `dita` command from the command line.\n\n```console\ncurl -LO https://github.com/dita-ot/dita-ot/releases/download/4.2/dita-ot-4.2.zip\nunzip -q dita-ot-4.2.zip\nrm dita-ot-4.2.zip\n```\n\n### Installing the Plug-in\n\n-   Run the plug-in installation commands:\n\n```console\ndita install https://github.com/jason-fox/fox.jason.extend.css/archive/master.zip\ndita install https://github.com/jason-fox/fox.jason.passthrough.pandoc/archive/master.zip\ndita install https://github.com/jason-fox/fox.jason.passthrough.swagger/archive/master.zip\ndita install https://github.com/jason-fox/fox.jason.passthrough.postman/archive/master.zip\n```\n\nThe `dita` command line tool requires no additional configuration.\n\n---\n\n### Installing Pandoc\n\nTo download a copy follow the instructions on the [Install page](https://github.com/jgm/pandoc/blob/master/INSTALL.md)\n\n## Usage\n\nTo mark a file to be passed through for **Postman** processing, label it with `format=\"postman\"` within the `*.ditamap`\nas shown:\n\n```xml\n\u003c?xml version=\"1.0\" encoding=\"UTF-8\"?\u003e\n\u003c!DOCTYPE bookmap PUBLIC \"-//OASIS//DTD DITA BookMap//EN\" \"bookmap.dtd\"\u003e\n\u003cbookmap\u003e\n    ...etc\n    \u003cappendices toc=\"yes\" print=\"yes\"\u003e\n      \u003ctopicmeta\u003e\n        \u003cnavtitle\u003eAppendices\u003c/navtitle\u003e\n      \u003c/topicmeta\u003e\n      \u003cappendix format=\"postman\" href=\"postman_collection.json\"/\u003e\n   \u003c/appendices\u003e\n\u003c/bookmap\u003e\n```\n\nThe additional file will be converted to a `*.dita` file and will be added to the build job without further processing.\nUnless overridden, the `navtitle` of the included topic will be the same as root name of the file. Any underscores in\nthe filename will be replaced by spaces in title.\n\n## License\n\n[Apache 2.0](LICENSE) © 2019 - 2024 Jason Fox\n\nThe Program includes the following additional software components which were obtained under license:\n\n-   json-simple-1.1.1.jar - https://github.com/fangyidong/json-simple - **Apache 2.0 license**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjason-fox%2Ffox.jason.passthrough.postman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjason-fox%2Ffox.jason.passthrough.postman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjason-fox%2Ffox.jason.passthrough.postman/lists"}