API Code Generator

The API Code Generator creates structured, standards-compliant code scaffolds for TIBCO® SOAP and REST services. It categorizes the output by transformation type (SOAP-to-SOAP, REST-to-REST, SOAP-to-REST) and generates implementation-ready projects in Java, Python, and C#. These scaffolds serve as a foundation for further development and integration into modern cloud-native platforms, allowing teams to focus on business logic rather than boilerplate code.

Post‑Processing Steps

Click the API code generator icon (labeled API / API Code) to view results when processing completes.
Review Columns
- API ID: Unique accelerator-level identifier.
- Total APIs: Total detected APIs.
- SOAP APIs: Total SOAP APIs.
- REST APIs: Total REST APIs.
- Processed APIs List: List of APIs processed.
- Failed APIs: Total number of APIs that failed to process.
- Failed APIs List: List of APIs that failed to process.
Download
- Download and inspect the project files generated for each transformation type in the output ZIP file, which includes three main directories:
1. Soap2SoapServices: Contains the generated SOAP service scaffolds.
2. RestServices: Contains the generated REST service scaffolds.
3. Soap2RestServices: Contains the generated REST service scaffolds derived from SOAP services.
Within each of these directories, you will find subdirectories organized by programming language:
- Java: Contains the Java code scaffolds for the API.
- Python: Contains the Python code scaffolds for the API.
- C#: Contains the C# code scaffolds for the API.
API Code Generator Soap to REST Java Example

Working with Output Files

Run Locally (via IDE or CLI)

Java (Spring Boot)

Prerequisites:
- Java JDK 17 (recommended) or 11
- Maven
Open the Java directory in your IDE. From the project root, install dependencies and run the application by executing:
Terminal window
```
mvn clean
mvn spring-boot:run
```
Copy the hosted URL from the terminal and open it in your browser to access the Swagger UI, typically:
```
http://localhost:8080/swagger-ui/index.html
```
The commands are same for both SOAP-to-REST and REST-to-REST services. For SOAP-to-SOAP services, use test suites instead.

Python (Flask)

Prerequisites:
- Python 3.9 or later
Open the Python directory in your IDE. From the project root, install dependencies by running:
Terminal window
```
pip install flask flask_restx
```
Run the app:
Terminal window
```
python app.py
```
Copy the hosted URL from the terminal and open it in your browser to access Swagger UI, typically:
```
http://127.0.0.1:5000
```
The commands are same for both SOAP-to-REST and REST-to-REST services. For SOAP-to-SOAP services, use test suites instead.

C# (.NET)

Prerequisites:
- .NET SDK 6.0 or later
- ASP.NET Core runtime
Open the C# project in your IDE. From the project root, run the following commands in the terminal:
Terminal window
```
dotnet restore
dotnet run
```
Navigate to the hosted Swagger URL shown in terminal output to access the Swagger UI, typically:
```
https://localhost:5000/
```
The commands are same for both SOAP-to-REST and REST-to-REST services. For SOAP-to-SOAP services, the folder contains WSDL artifacts that can be used further to create services.
For SOAP-to-REST, run the above commands in the src folder.

Testing in Swagger UI

Swagger UI will:
- List all available APIs
- Allow you to expand, inspect parameters, view schemas, and test
- Offer a “Try it out” mode with live execution and response
- Show the actual request sent (including curl format)
- Display response status code, body, and headers
At the bottom, you’ll find the Schemas section, which shows objects derived from original XSDs in TIBCO.
Please note that swagger UI is not supported for SOAP-to-SOAP services. Use Test Suites instead for testing those services.

Automated Test Suites

Each language scaffold directory includes automated tests that validate endpoint generation and response handling for quick verification. The execution steps for each language are as follows:

Java / Spring Boot

File: src/test/java/.../ApiControllerTest.java
Run via:
Terminal window
```
mvn test
```
Uses JUnit to run integration-style endpoint tests.

Python / Flask

File: tests/test_app.py
Run via:
Terminal window
```
pytest
```

The above is for Rest-to-Rest and SOAP-to-REST services. For SOAP-to-SOAP services, use:

pip install uvicorn requests
uvicorn main:app --host 0.0.0.0 --port 8000
pytest tests/test_service.py

Confirms all API scaffolds respond as expected.

C# / .NET

Run from the test project:
Terminal window
```
dotnet test
```
Uses built-in .NET test framework to verify scaffolds.

Note: These tests verify that the endpoints are generated and responding correctly. Application logic must still be implemented manually.

Next Steps

Implement Logic
- Open generated controller or handler files
- Insert your TIBCO-equivalent business logic as needed
Customize as Required
- Modify config files, dependency versions, and packaging
- Integrate monitoring, logging, auth, and other layers
Deploy
- Cloud-ready structure supports:
  - AWS (EKS)
  - Azure (AKS)
  - Google Cloud (GKE)
  - OpenShift / Kubernetes
- Or run in standalone mode

With this code scaffolding in place, your team can skip boilerplate setup and jump directly into logic implementation, enabling faster, safer API services modernization.

TIBCO® is a registered trademark of Cloud Software Group, Inc. and/or its subsidiaries in the United States and/or other countries. All other product names, logos, and brands are the property of their respective owners.