Step 4: Change the target endpoint

You're viewing Apigee X documentation.
View Apigee Edge documentation.

Now that you've tested your new proxy, you're almost ready to add a policy to it. Before you do that, though, change your proxy's target endpoint to one that returns some data.

Recall that in Step 1: Create an API proxy, you set the target endpoint (in the Existing API field) to https://mocktarget.apigee.net. Suppose that endpoint didn't return any interesting data. Then you can change the endpoint to one that does return some useful XML. This section explains how to do so.

New Proxy Editor

To change your proxy's target endpoint:

  1. Sign in to the Apigee UI.
  2. Select Develop > API Proxies.
  3. Select your proxy from the list to display the Overview tab for that proxy in the Proxy Editor. If you don't see your proxy in the list, be sure that you selected the right organization, as described in Switching between your organizations.
  4. Click the Develop tab. If you see the Try now button, click it to display the new Develop view.

    The Develop view is shown below.

    Develop view in the Proxy Editor

  5. In the left-hand pane, select Target Endpoints > default:

    Target endpoints for PreFlow select in the Proxy Explorer.

  6. Click Switch to Text Editor. This displays the XML code for the target endpoint in the Text editor.

    XML code for the proxy displayed in the Text editor.

    The target endpoint is defined by the <URL> element in <HTTPTargetConnection>.

  7. Change the URL to https://mocktarget.apigee.net/xml. (Append "/xml" to the existing URL.)

    The new URL returns a small block of XML in the body of the response.

    Your endpoint configuration should now look like the following:

    ...
    <HTTPTargetConnection>
      <Properties/>
      <URL>https://mocktarget.apigee.net/xml</URL>
    </HTTPTargetConnection>
    ...
  8. To save your changes to the proxy configuration, click the three-dot menu next to Save and select Save as new revision.

    Apigee saves your changes in a new proxy revision.

  9. To deploy the new revision, click the Overview tab and click Deploy.

Classic Proxy Editor

To change your proxy's target endpoint:

  1. Sign in to the Apigee UI.
  2. Select Develop > API Proxies.
  3. Select your proxy from the list to display the API proxy details. If you don't see your proxy in the list, be sure that you selected the right organization, as described in Switching between your organizations.
  4. Click the Develop tab:

    This takes you to the API Proxy Editor. The Proxy Editor lets you see the structure of your API proxy and configure its flow. (A flow is just the stepwise path an API proxy request takes through the Apigee platform. Other tutorials will cover the concept of flows.)

  5. In the Navigator pane, select Target Endpoints > default > PreFlow:

    Apigee displays the endpoint settings in the Code pane:

    <TargetEndpoint name="default">
      <Description/>
      <FaultRules/>
      <PreFlow name="PreFlow">
        <Request/>
        <Response/>
      </PreFlow>
      <PostFlow name="PostFlow">
        <Request/>
        <Response/>
      </PostFlow>
      <Flows/>
      <HTTPTargetConnection>
        <Properties/>
        <URL>https://mocktarget.apigee.net</URL>
      </HTTPTargetConnection>
    </TargetEndpoint>

    The target endpoint is defined by the <HTTPTargetConnection> element.

  6. Change the URL to "https://mocktarget.apigee.net/xml". (Append "/xml" to the existing URL.)

    The new URL returns a small block of XML in the body of the response.

    Your endpoint configuration should now look like the following:

    ...
    <HTTPTargetConnection>
      <Properties/>
      <URL>https://mocktarget.apigee.net/xml</URL>
    </HTTPTargetConnection>
    ...
  7. To save your changes to the proxy configuration, click the Save button.

    Apigee saves your changes in a new proxy revision.

  8. To deploy the new revision, select Deploy to: test and click Deploy 2.
  9. In the confirmation dialog, click Deploy.

    If there is an error, Apigee will save your changes but not deploy the proxy. In the case of an error:

    1. Fix your proxy configuration. Apigee may provide syntax guidance as a pop-up.
    2. Manually deploy your changes to the test environment by clicking Deployment > test if Apigee does not automatically deploy it.

    You can check if your proxy revision was deployed successfully by viewing the deployment revision status adjacent to the Deploy drop-down. For example:

Test the proxy

You can test your changes by sending a request to your proxy, just as you did in Call your API proxy. For example:

curl -v https://YOUR_ENV_GROUP_HOSTNAME/myproxy

where YOUR ENV_GROUP_HOSTNAME is the environment group hostname. See Find the environment group hostname.

This time, the mocktarget endpoint returns XML in the body of the response:

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <city>San Jose</city>
  <firstName>John</firstName>
  <lastName>Doe</lastName>
  <state>CA</state>
</root>

Now that the API proxy returns XML data, in the next step you will add a policy that converts XML to JSON.

Next step

1 2 3 4 (NEXT) Step 5: Add a policy