Publishing rest services

StepanBouda

Hi,

we need to expose an API from appworks to integrate it with external systems. We prepared YAML files for our REST interfaces and the interface will look like this:

/api/Customers - GET - Returns all customers

/api/Customers/123 - GET - Returns a customer with ID 123

/api/Customers/123 - POST - Updates a customer

Our idea is to expose this rest interface and this interface will internally call a business process to handle the business logic. This interface will also convert the JSON data to XML and pass the data to the business process as an input message.

This service should be configurable, so, for example, can consume the YAML file, dynamically expose rest endpoints, validate requests, and using a custom attribute in the YAML file will call the corresponding business process.

Finally question: How to develop this functionality? Should it be an app in Appworks Gateway / Custom service container /custom WAR in AppWorks (something like BPMService.war )

jpluimers

@Stepan_Bouda, in AppWorks Platform 20.4 the type Entity REST API is introduced. This provides a native REST interface on top of your entities. In AWP 20.4 this API allows to do CRUD and List operations on Entities. We're extending this API with each release.

See the AppWorks Platform 20.4 Release notes document https://knowledge.opentext.com/knowledge/llisapi.dll/fetch/2001/3551166/27083025/74197323/78049113/AppWorks_Platform_CE_20.4_Release_Notes.pdf?nodeid=78049116&vernum=-2

Ethan Beisher

@Johan_Pluimers I believe @Stepan_Bouda is referring to AppWorks Gateway as opposed to AppWorks Platform.

Stepan_Bouda can you please clarify. What product are you referring to, what version are you using, and can you please post any project that you have built so far so that we can advise? Perhaps a screen shot of your configuration would be helpful.