Talend ESB | Update generated Swagger

[Ziedkh]

Hello,

How can we customize the generated swagger Def of tRESTRequest :

 

I want to makes parameters as required, add schema, add responses codes and messages ...

Any suggestions please @xdshi @richard Hall​ 

[Anonymous · Accepted solution]

Hello,

The Swagger API documentation generation for restful components is now deprecated.

For more information, please have a look at this KB article:

https://community.talend.com/s/article/The-future-of-Swagger-UI-generated-by-tRESTRequest-and-cREST-...

Talend API Designer can be used in combination with Studio Routes and Data Services to achieve this. This is available in the Talend Cloud API Services product.

Best regards

Sabrina

[Jacco_De_Zwart]

Hi Sabrina,

Since the update of Talend Studio 2025-10 this feature is back !

But what I'm missing is documentation on how to do this.

Can you help ???

[Xiaodi_Shi]

Hello @Jacco_De_Zwart 
Please allow me to check it with our R&D team firstly and then come back to you asap.

Best regards

Sabrina

[Xiaodi_Shi · Accepted solution]

Hello @Jacco_De_Zwart 
You are able to execute Talend Tasks via APIs and you can find link to the latest API here
https://talend.qlik.dev/apis/

Best regards

Sabrina

[Jacco_De_Zwart]

Sabrina,

Sorry to say, but this is not what I ment.

Since the latest update this :

is back.

But when I try this, according to the recent documentation of the tRestRequest component

I get this as a result :

 My question is, where does this documentation comming from ? In the API-Designer, on which this end-point is based, I added a lot more information regarding the end-point. But that is not shown in the swagger page shown above.

So, how do I get more (or the same documentation as in API-Designer) in this swagger page ?

The link in this post, points to a KB-Article stating that this functionality was dropped, but it is back since the 2025-10 release of Talend Studio.

Hope this helps a bit more.

[Xiaodi_Shi]

Hello @Jacco_De_Zwart 
Thanks for your information and confirmation.

Does the Swagger page display well If you run the web service locally in the Studio at the following address:
http://127.0.0.1:8090/api/1.0/organisation/api-docs

In addition to that, for Openapi, there is a known issue from the runtime side and

it is now fixed in Studio update R2025-11.

https://update.talend.com/Studio/8/updates/R2025-11

The November release R2025-11 (which fixes this runtime issue) is available and the Update notification will pop-up from your Studio to prompt you to update

Best regards

Sabrina

[Xiaodi_Shi]

Hello,
The steps should be like(2025-11 newest version )

- Web service with the “Expose OpenAPI documentation” checkbox enabled
- Result of the Swagger call in localhost (from the Studio)
- Publish options is used to build and deploy to your Nexus()
- Result of the deployed web service on the runtime server
- Result of the Swagger call on the deployed runtime

Don't forget to install the feature cxf-rs-description-openapi-v3 in karaf :
--> feature:install cxf-rs-description-openapi-v3

[Jacco_De_Zwart]

Hi Sabrina,

Thanks for the information. But on localhost the swagger is still not complete. The swagger page is show, but I don't know where the information that should be on it comes from.

So, yes it shows a swagger page, but I don't know what to expect when I don't know where the information for that swagger page is comming from.

Should it come from API-Designer, should it come from component configuration ?

Jacco