{"id":31363740,"url":"https://github.com/krusty84/tcapi2postman","last_synced_at":"2026-06-29T11:31:20.327Z","repository":{"id":314639257,"uuid":"1055634445","full_name":"Krusty84/TCApi2Postman","owner":"Krusty84","description":"TCApi2Postman is application that converts auto-generated REST API documentation from Teamcenter into a fully-loaded Postman collection.","archived":false,"fork":false,"pushed_at":"2025-10-22T17:02:01.000Z","size":28,"stargazers_count":2,"open_issues_count":0,"forks_count":3,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-22T19:07:09.804Z","etag":null,"topics":["plm","postman","rest-api","siemens-xcelerator","teamcenter","teamcenter-soa"],"latest_commit_sha":null,"homepage":"https://plm.sw.siemens.com/en-US/teamcenter/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Krusty84.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-12T14:59:48.000Z","updated_at":"2025-10-22T17:02:05.000Z","dependencies_parsed_at":"2025-09-13T19:40:02.900Z","dependency_job_id":"1389d384-3a7b-4d79-b765-98bd60a76280","html_url":"https://github.com/Krusty84/TCApi2Postman","commit_stats":null,"previous_names":["krusty84/tcapi2postman"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Krusty84/TCApi2Postman","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Krusty84%2FTCApi2Postman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Krusty84%2FTCApi2Postman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Krusty84%2FTCApi2Postman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Krusty84%2FTCApi2Postman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Krusty84","download_url":"https://codeload.github.com/Krusty84/TCApi2Postman/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Krusty84%2FTCApi2Postman/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34925718,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-29T02:00:05.398Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["plm","postman","rest-api","siemens-xcelerator","teamcenter","teamcenter-soa"],"created_at":"2025-09-27T05:08:29.240Z","updated_at":"2026-06-29T11:31:20.323Z","avatar_url":"https://github.com/Krusty84.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TCApi2Postman\n\n## What is this?\n\nTCApi2Postman is application that converts auto-generated REST API documentation from Teamcenter into a fully-loaded Postman collection. \nIt doesn’t just spit out a bunch of requests—it packs each method with detailed documentation, ready to roll in Postman. \n\n--\n\n## Features\n\n- Transforms Teamcenter REST API documentation (structure.js) into a Postman collection.\n\n- Auto-populates each request with rich, detailed documentation for every API method.\n\n- Supports optional inclusion of internal APIs with the --include-internal flag.\n\n- Allows customization via a config file with the --config option.\n\n- Outputs a clean, ready-to-import .json file for Postman.\n\n## Who is it for?\n\nDevelopers, QA engineers, Presales, etc. working with Teamcenter REST APIs\n\n## Instructions\n\n### Prerequisites\n\n- **Java 17 or later** (e.g., Azul Zulu, OpenJDK, or Oracle JDK)\n  - Verify installation: `java -version`\n  - Set `JAVA_HOME` environment variable to your JDK installation directory\n\n- **Maven 3.6 or later** (required to build from source)\n  - Download from https://maven.apache.org/download.cgi or use a package manager (e.g., `choco install maven` on Windows with Chocolatey)\n  - Verify installation: `mvn -version`\n\n### Build TCApi2Postman from Source\n\nIf you're building from source, follow these steps:\n\n1. Clone or download this repository\n2. Navigate to the project directory\n3. Run the build:\n   ```bash\n   mvn clean package\n   ```\n4. The compiled jar will be in the `target/` directory (named `TCApi2Postman-1.0.0.jar`)\n\n### Get Your Input Data\n\nYou'll need the `structure.js` file from your Teamcenter setup (AWC layer). Generate or regenerate it using:\n\n- cd ...\\aws2\\stage\n- initenv\n- npm run genSoaApi\n- cd ...\\aws2\\stage\\out\\soa\\api\n\n**Note:** You must regenerate `structure.js` after updating Teamcenter Core or AWC to ensure the API documentation is up-to-date with the latest changes.\n\n**Note:** To include unpublished (Internal) API, before building structure.js, you MUST modify aws2\\stage\\initenv.cmd by adding a new line with the environment variable **SOAGENAPI_INCLUDE_UNPUBLISHED** set to true: \n   ```bash\n   SET SOAGENAPI_INCLUDE_UNPUBLISHED=true\n   ```\n\n### Run TCApi2Postman\n\nUse the command below to convert your API docs to a Postman collection:\n\n**java -jar TCApi2Postman-1.0.0.jar** \u003cstructure.js\u003e \u003cout.postman_collection.json\u003e [--include-internal] [--config \u003cTCApi2Postman.config\u003e]\n\n**Example:**\n```bash\njava -jar TCApi2Postman-1.0.0.jar C:\\Siemens\\Teamcenter\\13\\aws2\\stage\\out\\soa\\api\\structure.js D:\\Temp\\TcApi_collection.json --config TCApi2Postman.config\n```\n\n\n**Options:** \n**--include-internal:** Include internal APIs in the output (optional, for the brave).  \n**--config \u003cfile\u003e:** Point to a custom config file for extra control.\n\nImport to Postman: Load the generated .json file into Postman, and you’re good to go!\n\n\u003cimg width=\"1167\" height=\"283\" alt=\"image\" src=\"https://github.com/user-attachments/assets/fbbcc01e-02d3-40bb-a0a8-e69b029b8ae4\" /\u003e\n\n\u003cimg width=\"673\" height=\"36\" alt=\"image\" src=\"https://github.com/user-attachments/assets/2389e358-844e-4249-be6c-e90ff279eab3\" /\u003e\n\n\u003cimg width=\"1830\" height=\"1001\" alt=\"image\" src=\"https://github.com/user-attachments/assets/9709650a-ee8e-4b00-90e3-3bd514342f43\" /\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkrusty84%2Ftcapi2postman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkrusty84%2Ftcapi2postman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkrusty84%2Ftcapi2postman/lists"}