1.2 Local deployment of Web Service Documentation

This topic provides an overview on serving web service documentation from your local machine or server.

Follow the below steps to host the Web Service Documentation locally:

  1. Obtain the Web_Service_Documentation.zip and place it in the destination folder.
    Web Service Documentation UI needs an HTTP Server to render itself. You can run a standalone HTTP Server using Python.
  2. Assuming the Web_Service_Documentation.zip is extracted on a Windows machine in the following path D:\OBPM\WebServiceDoc\Web_Service_Documentation, run the following command cmd>cd D:\OBPM\WebServiceDoc\Web_Service_Documentation to start a HTTP Server using Python.
    8888 is the port for the HTTP server to listen.
  3. Run the following command from the browser.
    • python -m SimpleHTTPServer 8888, if Python version is older than Python.
    • python -m htp.server 8888, if Python version is Python 3.

    To use a port other than 8888, first ensure the new port is available for listening. Then, update all instances of 8888 in the commands above with the new port number. Make sure to also update the port number in the URL below accordingly.

  4. Navigate to WebServiceIndex at http://localhost:8888/Web_service_documentation/ WebServiceIndex.htm to access the Web Service Documentation UI.
    The Oracle Banking Payments - Web Services screen appears.

    Figure 1-4 Oracle Banking Payments - Web Services


    Description of Figure 1-4 follows
    Description of "Figure 1-4 Oracle Banking Payments - Web Services"

  5. Click the required SOAP service from the scrollable list.
    For example, click the AccountFetchService to view the list of operations supported by that SOAP service.

    Figure 1-5 Click the required SOAP service


    Description of Figure 1-5 follows
    Description of "Figure 1-5 Click the required SOAP service"

  6. Select the required operation to view the associated XSDs for that operation.

    Figure 1-6 Select the required operation


    Description of Figure 1-6 follows
    Description of "Figure 1-6 Select the required operation"

  7. Click the desired XSD to view detailed information about its fields and format.

    Figure 1-7 Click the desired XSD


    Description of Figure 1-7 follows
    Description of "Figure 1-7 Click the desired XSD"

  8. Click the specific field to view the description of that field along with its attributes and constraints.

    Note:

    In the left panel, select the Expand icon to display the XSD format and its fields, or select the Collapse icon to hide them.

    Figure 1-8 View attributes and constraints


    Description of Figure 1-8 follows
    Description of "Figure 1-8 View attributes and constraints"

Parent topic: Hosting Web Services Documentation Locally