Updating Converted Application Services for Compliance

After converting the Chatbot Application Service, it becomes necessary to update the Application Service for compliance if the Application Service will also be used as REST API. Perform the following steps to rearchitect the services.

Keep in mind, that these are no longer Chatbot services, they are REST Services that are being used for Chatbot.

1. Logically group services.

   Chatbots are converted as individual services, however these converted services can be logically grouped by module.

2. Identify the proper HTTP method to use for each application service.

   • GET - Retrieve information about a resource.

   • POST - Create a resource.

   • PUT - Update a resource.

   • DELETE - Delete a resource.

   • PATCH - Update partial resources.

3. Create URI Template.

   The URI template is used to point to the resource.

4. Comply with naming standards.

   Use Oracle naming standards for Service, Root, URI and Fields. The Application Service Framework (ASF) will verify the naming conforms to the standards.

5. Add descriptions.

   Third parties use the descriptions to identify what the service does. Theses are REST API services that interface with Chatbot.

6. Identify Response Codes.

   Third party will see the response code.

7. Create Headers for request/response if necessary.

   Chatbots do not use headers. For a newly created resource you may want to add location header, which will point to the new resource.

8. Add exception detail resource type.

   Ability to override what the third party will see for the exception.