IBM Integration Bus, Version 10.0.0.0 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS


Restrictions on Swagger documents

IBM® Integration Bus has some restrictions on the Swagger documents that you can use to create a REST API that are in addition to the requirements that are specified in Swagger RESTful API Documentation Specification Version 2.0.

IBM Integration Bus supports version 2.0 of the Swagger specification. For information about Swagger, see Swagger. For information about version 2.0 of the Swagger specification, see Swagger RESTful API Documentation Specification Version 2.0.

IBM Integration Bus places certain restrictions on the format of Swagger documents that are used to create REST APIs:
  • The Swagger document must be saved as a .json file.
  • You must enter a value for the operationId field in the Operation Object, and the value of the operationId field must be unique across all operations that are defined in this REST API. IBM Integration Bus uses the operation ID as a unique name to refer to the operation.
  • The base paths of all REST APIs deployed to a single integration server must be unique. You cannot deploy a REST API to an integration server if there is already another REST API deployed with the same base path.
  • Form data parameters are permitted in Swagger documents by IBM Integration Bus, but no support is provided for parsing form data parameters.

bi12026_.htm | Last updated 2015-03-27 19:28:16