1.56 REST Binding Configuration Wizard

Use the REST Binding Configuration Wizard to create a REST binding and select operations for it to perform.

REST Binding Configuration Wizard (Step 1 of 2)

Element Description

Name

Enter a name for the REST binding.

Type

Select the type of REST binding to create:

  • Service: Creates an inbound REST binding in the Exposed Services (left) swimlane that provides the outside world with an entry point to the SOA composite application. This direction is selected by default if you dropped the REST binding into the Exposed Services swimlane.

  • Reference: Creates an outbound REST binding in the External References (right) swimlane that enables messages to be sent from the SOA composite application to external partners in the outside world. This direction is selected by default if you dropped the REST binding into the External References swimlane.

Reference will be invoked by components using WSDL interfaces

Appears if you select Reference for Type. If you select this option, binding maps WSDL operations and XML Schemas to the REST resources/verbs, with outbound payloads being translated from XML.

Service will invoke components using WSDL interfaces

Appears if you select Service for Type. If you select this option, binding maps REST resources/verbs to internal WSDL operations and XML Schemas, with inbound payloads being translated from XML.

Description

Enter a description. The description is published as part of the readable API used during deployment. The description is only available for service binding components. References have the Base URI field.

Enforce XML Schema Ordering

Select to enforce the ordering of the XML schema.

When selected, this reorders JSON payloads to match the order of elements in the XML schema. This includes inbound request payloads and responses from outbound requests. This option may add a performance overload.

Selecting this check box sets the REST service binding property reorderJsonAsPerXmlSchema to true in the composite.xml file.

REST Binding Configuration Wizard (Step 2 of 2)

Element Description
WADL or Swagger Document URL

Enter the URL of the Swagger document for the hybrid integration you want to use in your SOA composite application or Service Bus application. The wizard fetches the contents of the Swagger document, converts it into WADL, and displays the resources.

Alternatively, click the + icon to the right of this field to open the WADL or Swagger Chooser dialog, where you can select an integration created in Oracle Integration.

"Create a REST Binding" in Developing SOA Applications with Oracle SOA Suite or Developing Services with Oracle Service Bus

Base URI

Appears if you choose Reference option for Type. This field is auto-populated.

Description

Appears if you choose Service option for Type. Enter a description. The description is published as part of the readable API used during deployment. The description is only available for service binding components.

Resource Path

Enables you to manage (add, edit, and delete) REST resource paths. A resource is any source of specific information that can be addressed. Each operation in the Operation Binding section of this dialog must belong to a resource path.

For example, a resource path may consist of the following operations located in multiple locations of the REST binding base URL:

  • Place an order (REST_binding_base_URL/Orders)

  • Pay for an order (REST_binding_base_URL/Orders/OrderID)

  • View an order (REST_binding_base_URL/Orders/OrderID)

  • Get all orders (REST_binding_base_URL/Orders)

  • Verify payment of an order (REST_binding_base_URL/Orders/OrderID)

  • Delete an order (REST_binding_base_URL/Orders/OrderID)

Operation Bindings

Click Add and select to define the REST operations based on the WSDL of the component with which the REST service interfaces.

  • Select Add operation binding to manually define the rest service definition. You can define resource paths and REST operations. An underlying WSDL is generated that contains the mapping from the REST definition to the WSDL. For more information about this selection, see How to Generate Schemas Manually.

  • Select REST enable component or reference to invoke the Service Explorer dialog to select the WSDL of the service component or external reference from which to map WSDL operations to resource paths and HTTP verbs. This option is only available to service binding components. This selection is described in subsequent steps of this section.

  • Select REST enable external webservice to invoke the WSDL Chooser dialog to select a WSDL from many sources including the application server and SOA-MDS. After the WSDL is selected, the REST adapter is automatically populated with operation mappings for the selected WSDL. On completion of the dialog, a REST service, SOAP reference, and wire between the two are created.

Resource Path Section

Element Description

Resource Path Table

Double-click to edit the REST resource path. By default, a / path is automatically provided. You can edit the default path or add additional paths by clicking the Add icon.

When you specify a resource path for an operation, it is added to the Resource Path column of the Operation Bindings section of this dialog.

Any resources paths that are unused are ignored.

Add icon

Click to add more REST resource paths.

Edit icon

Click to edit a selected resource path.

Delete icon

Click to delete a selected resource path.

Operation Bindings Section

Element Description

Operation Bindings Table

Double-click an operation to invoke the REST Operation Binding dialog for specifying a resource path and HTTP verb.

Add

Select to define REST service operations.

Add operation binding

Select to manually add REST operations. Any operations you add are also added to the WSDL file.

REST enable component or reference

Select to invoke the Service Explorer dialog to select the WSDL of the service component or external reference from which to map WSDL operations to resource paths and HTTP verbs. This option is only available to service binding components.

REST enable external webservice

Select to invoke the WSDL Chooser dialog to select a WSDL from many sources including the application server and SOA-MDS. After the WSDL is selected, the REST adapter is automatically populated with operation mappings for the selected WSDL. On completion of the dialog, a REST service, SOAP reference, and wire between the two are created.

Edit icon

Click to edit a selected operation binding (such as the operation's resource path or HTTP verb) in the REST Operation Binding dialog.

Delete icon

Click to delete a selected operation binding.