topic Re: Talend ESB | Update generated Swagger in Talend Studio

Talend ESB | Update generated Swagger

Ziedkh — Fri, 15 Nov 2024 23:28:42 GMT

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

Re: Talend ESB | Update generated Swagger

Anonymous — Mon, 17 Jan 2022 09:57:55 GMT

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-FPg9G

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

Re: Talend ESB | Update generated Swagger

Jacco_De_Zwart — Wed, 03 Dec 2025 08:13:58 GMT

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 ???

Re: Talend ESB | Update generated Swagger

Xiaodi_Shi — Wed, 03 Dec 2025 09:06:18 GMT

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

Re: Talend ESB | Update generated Swagger

Xiaodi_Shi — Wed, 03 Dec 2025 09:15:45 GMT

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

Re: Talend ESB | Update generated Swagger

Jacco_De_Zwart — Thu, 04 Dec 2025 11:50:05 GMT

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.

Re: Talend ESB | Update generated Swagger

Xiaodi_Shi — Fri, 05 Dec 2025 04:22:50 GMT

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

Re: Talend ESB | Update generated Swagger

Xiaodi_Shi — Fri, 05 Dec 2025 04:18:16 GMT

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

Re: Talend ESB | Update generated Swagger

Jacco_De_Zwart — Fri, 05 Dec 2025 15:04:57 GMT

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

Re: Talend ESB | Update generated Swagger

Xiaodi_Shi — Mon, 08 Dec 2025 02:00:49 GMT

Hello @Jacco_De_Zwart
Good day to you and let me check it with our ESB Product Manager to see if we could give you more information and documentations about that.
I will come back to you asap.
Best regards

Sabrina

Re: Talend ESB | Update generated Swagger

Xiaodi_Shi — Wed, 10 Dec 2025 10:09:58 GMT

Hello @Jacco_De_Zwart

Since Expose OpenAPI documentation within RESTful Data Services and Routes (tRESTRequest / cREST) produces online API documentation.
Please see my screenshot for API

The feature should be

REST components (tRESTRequest and cREST), in Studio, offer a way to activate documentation
Activation/De-activation can also be overridden at deployment time with microservices configuration(2025-11)
When documentation is activated, deployed REST service offers endpoint(s) to access documentation either as plain text or with a nice UI

OpenAPI.json

tRESTRequest component run in studio and “Expose OpenAPI documentation” enabled

URLs from the list below are available:

http://localhost:8090/services/customers/openapi.json

http://localhost:8090/services/customers/api-docs

In http://localhost:8090/services/customers/api-docs, you could try the methods GET/POST

Best regards

Sabrina

Re: Talend ESB | Update generated Swagger

Xiaodi_Shi — Wed, 10 Dec 2025 10:14:42 GMT

Hello,

The broken KB article link in this thread can be available here without newer information and we will update it as soon as we can.

https://community.qlik.com/t5/Official-Support-Articles/Talend-ESB-The-future-of-Swagger-UI-generated-by-tRESTRequest/ta-p/2151734

Best regards

Sabrina