How to manage a Swagger file update in BusinessWorks 6.X and BusinessWorks Container Edition

BusinessWorks 6.X and BusinessWorks Container Edition conveniently allow the creation of Processes exposing or invoking REST APIs using Swagger files previously created, this approach is usually called the design first approach.

But once Processes have been implemented how to manage the case where a new version of the Swagger file is delivered and has to be taken into account ?

This can be done using the approach described in this article.

Uploading the new Swagger file

It is recommended to first make sure the latest version of the application code can be recovered in case of problems.

Then import the updated Swagger file, the file name of the updated Swagger should be the exact same file name as in the original import.

Importing the new version of the Swagger file

Finally confirm that you want to overwrite the existing file.

Updating the XML Schemas

Refresh the XML Schemas generated when the Service or Reference were initially created in the Process by Right clicking on the Swagger file and selecting ‘Refactor -> Generate XSD Schema …’

Refreshing the XML Schemas

In the next panel click finish

Refreshing the XML Schemas

Then it is recommended to do a project clean

Updating the processes

You now have to update the impacted Processes to take into account the changes, this mostly consist in:

. Removing mappings corresponding to fields that no longer exist

. Creating mappings for new fields

To speed up the work you can just check errors present in each process and fix them one by one. Remember also you can use the ‘Quick fix’ option in many cases.

I work as an Architect at TIBCO on Integration products. Opinions here are my own.