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​ 

[Xiaodi_Shi]

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

So 

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

[Xiaodi_Shi]

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-generate...

Best regards

Sabrina