Create a new REST Command in Websphere Commerce

1. Create a  new controller Command:

 

Package Name: com.mycompany.commerce.commands

Interface Name :com.mycompany.commerce.commands.MyCompanyControllerCmd

Class Name:com.mycompany.commerce.commands.MyCompanyControllerCmdImpl

   

       Interface and impl class

2. Then Run the RESTClassicSampleGen.bat file from "C:/IBM/WCDE_ENT70/bin/" for generate the xml mapping files and handler classes.

RESTClassicSampleGen.bat location=com.mycompany.commerce.commands.MyCompanyControllerCmd outputDir=C:\RESTconfig additionalClassPath="C:\IBM\WCDE_ENT70\workspace\WebSphereCommerceServerExtensionsLogic\bin"

3. If successfully runs, then the following  2 folder are created in "C:\RESTconfig"

• controllerCommandSamples
• handlerSamples

4. In the Enterprise Explorer view, go to REST > WebContent > WEB-INF > config.

1. Create the  commandMapping-ext mapping folders.
   1. Right-click config. Click New > Folder.
   2. In the Folder name field, enter commandMapping-ext.
   3. Click Finish. The commandMapping-ext folder is created under the config directory.
2. Copy the sample configuration to the REST configuration folder that you created
   1.  from working_dir\dataBeanSamples to the new folder: beanMapping-ext.
   2. Copy com.mycompany.commerce.commands.MyCompanyControllerCmd.xml from working_dir\controllerCommandSamples to the new folder: commandMapping-ext.

5.Go to REST > WebContent > WEB-INF > config > commandMapping-ext > .

   

Open the com.mycompany.commerce.commands.MyCompanyControllerCmd.xml file.   Change the profile name from sample to MyCommand_Summary and add the input and output parameters for the rest command.

 

 The following snippet shows the updated code:

<?xml version="1.0" encoding="UTF-8"?>
<command>
     <profiles>
          <profile name="MyCommand_Summary">
               <inputs>
                    <input inputName="field1" methodName="setField1"/>
                    <input inputName="field2" methodName="setField2"/>
               </inputs>
               <outputs>
                    <output methodName="getMyResourceId" outputName="myResourceId"/>
               </outputs>
          </profile>
     </profiles>
</command>

6.Update Handler

1. In the Enterprise Explorer view, browse to WebSphereCommerceServerExtensionsLogic > src. Click New > Package.
2. In the Name field, enter com.mycompany.commerce.rest.mycomponent.handler. Click Finish.
3. Right-click the com.mycompany.commerce.rest.mycomponent.handler package. Click Import > General > File system.
4. Click Next. Click Browse and browse to your sample code directory. For example, C:\source\workspace\WebSphereCommerceServerExtensionsLogic\src\com\mycompany\commerce\rest\mycomponent\handler. Select the Myresourcehandler.java file. Click Finish to import the file. (The class file is built automatically, so no need to copy it).
5. Open the Myresourcehandler.java file.
   The following methods are implemented:

   findByMyResourceId

   The REST handler runs the MyResourceDataBean based on the REST input and the corresponding configuration mapping profile MyCompany_Databean_Summary. This method is used to get the resource data from MyResourceDataBean according to the myResourceId you specified. It uses findByMyResourceId as method name, storeId, myResourceId, and responseFormat as parameters, and store/{storeId}/my_resource/{myResourceId} as the path.

   findMyResourceList

   The REST handler runs the MyResourceListDataBean based on the REST input and the corresponding configuration mapping profile MyCompany_DatabeanList_Summary. This method is used to get the list of resource data, such as, 0 to more resource data from MyResourceListDataBean. It uses findMyResourceList as method name, storeId, and responseFormat as parameters, and the path that is defined for this method is store/{storeId}/my_resource/myResourceListDataBean.

   create

   The REST handler runs the MyResourceCreateCmd based on the REST input and the corresponding configuration mapping profile MyCommand_Summary. This method is used to create a new data by a command (POST). It uses create as method name, storeId, and responseFormat as parameters, and store/{storeId}/my_resource as path. It retrieves context parameters from the query and other input parameters from the request body.

   You also can use GET methods to implement queries, specifically find by primary key, find by identifier/name, and find by query. Implement queries by using find by query with internal GET methods. Avoid using GET methods with custom paths as they must be manually created, since they are not generated by the utility.

   initializeQueryRegistry

   This method initializes the new Query registry.

   FindByQuery

   This method is to implement the GET method. It uses findByQuery as method name, storeId as parameter, and store/{storeId}/resource_nameas path, such as /{storeId}/my_resource. It uses the query registry framework to map query names to internal GET methods per the REST API Discoverability.

   findSelf

   The REST handler runs the MyResourceListDataBean based on the REST input and the corresponding configuration mapping profile MyCompany_DatabeanList_Summary. This method is used to get the list of resource data created by the current user. It uses findSelf as method name, storeId as parameter, self as query name, the store/{storeId}/ my_resource?q=self as path.

   For more information about these methods, see the local Swagger UI at the following URL: http://localhost/webapp/wcs/stores/servlet/swagger/index.html.
    
    
6. Register your new resource handler:
   1. In the Enterprise Explorer view, browse to the REST > WebContent > WEB-INF > config > resources-ext.properties file.
   2. Define the new resource handler that you created:

      # Extended Resources
      com.mycompany.commerce.rest.mycomponent.handler.MyResourceHandler

   3. Save and close the file.
   Next, verify your REST service calls in a web browser.