https://github.com/krusty84/tcapi2postman
TCApi2Postman is application that converts auto-generated REST API documentation from Teamcenter into a fully-loaded Postman collection.
https://github.com/krusty84/tcapi2postman
plm postman rest-api siemens-xcelerator teamcenter teamcenter-soa
Last synced: about 12 hours ago
JSON representation
TCApi2Postman is application that converts auto-generated REST API documentation from Teamcenter into a fully-loaded Postman collection.
- Host: GitHub
- URL: https://github.com/krusty84/tcapi2postman
- Owner: Krusty84
- License: mit
- Created: 2025-09-12T14:59:48.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-10-22T17:02:01.000Z (8 months ago)
- Last Synced: 2025-10-22T19:07:09.804Z (8 months ago)
- Topics: plm, postman, rest-api, siemens-xcelerator, teamcenter, teamcenter-soa
- Language: Java
- Homepage: https://plm.sw.siemens.com/en-US/teamcenter/
- Size: 27.3 KB
- Stars: 2
- Watchers: 0
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TCApi2Postman
## What is this?
TCApi2Postman is application that converts auto-generated REST API documentation from Teamcenter into a fully-loaded Postman collection.
It doesn’t just spit out a bunch of requests—it packs each method with detailed documentation, ready to roll in Postman.
--
## Features
- Transforms Teamcenter REST API documentation (structure.js) into a Postman collection.
- Auto-populates each request with rich, detailed documentation for every API method.
- Supports optional inclusion of internal APIs with the --include-internal flag.
- Allows customization via a config file with the --config option.
- Outputs a clean, ready-to-import .json file for Postman.
## Who is it for?
Developers, QA engineers, Presales, etc. working with Teamcenter REST APIs
## Instructions
### Prerequisites
- **Java 17 or later** (e.g., Azul Zulu, OpenJDK, or Oracle JDK)
- Verify installation: `java -version`
- Set `JAVA_HOME` environment variable to your JDK installation directory
- **Maven 3.6 or later** (required to build from source)
- Download from https://maven.apache.org/download.cgi or use a package manager (e.g., `choco install maven` on Windows with Chocolatey)
- Verify installation: `mvn -version`
### Build TCApi2Postman from Source
If you're building from source, follow these steps:
1. Clone or download this repository
2. Navigate to the project directory
3. Run the build:
```bash
mvn clean package
```
4. The compiled jar will be in the `target/` directory (named `TCApi2Postman-1.0.0.jar`)
### Get Your Input Data
You'll need the `structure.js` file from your Teamcenter setup (AWC layer). Generate or regenerate it using:
- cd ...\aws2\stage
- initenv
- npm run genSoaApi
- cd ...\aws2\stage\out\soa\api
**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.
**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:
```bash
SET SOAGENAPI_INCLUDE_UNPUBLISHED=true
```
### Run TCApi2Postman
Use the command below to convert your API docs to a Postman collection:
**java -jar TCApi2Postman-1.0.0.jar** [--include-internal] [--config ]
**Example:**
```bash
java -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
```
**Options:**
**--include-internal:** Include internal APIs in the output (optional, for the brave).
**--config :** Point to a custom config file for extra control.
Import to Postman: Load the generated .json file into Postman, and you’re good to go!
