Petals BC REST

bc-soap displays the list of services exposed but bc-rest does not.

Clear documentation of the APIs deployed is a plus for users and avoids a tedious job of maintaining documentation.

the openapi initiative offers a standard for documenting APIs.
Swagger-ui provides a user-friendly display of documentation.

It is possible to automate the generation of this documentation and to expose it with swagger-ui (as spring can do for example).

swagger-ui can be started on a port different from the bc-rest (so as not to reserve a specific endpoint). The port is configurable via a parameter at the start of the bc-rest (for example -D swaggerPort = 8088)
ideally the documentation update is done with each loading or unloading of a su rest "consumes".
 
This documentation must be configurable

• a global parameter to activate or deactivate automatic documentation on the instance
• a parameter in jbi:consume (as rest:service-base-path)
• one parameter per operation

thank you