Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

New API proxy editor highlights

If you're developing API proxies on Edge, chances are you spend time using the API proxy editor UI. The new version of this UI (as of cloud release 15.05.27) includes some new features and usability improvements. If you're used to using the "classic" version of the UI, you'll adapt readily to the new version.

This topic points out the main differences between the "classic" and "new" versions of the UI, and is intended to help you get up to speed quickly with the new look and feel.

You can switch back and forth between the "classic" and "new" editors.

New API proxy wizard

As of cloud release 16.01.20, a new wizard appears when you click API > API Proxies > + API Proxy in the management UI. The wizard provides a more guided experience than the previous wizard, and it also lets you create API proxies based on OpenAPI (Swagger) documents.

How to get to the UI

The new proxy editor should be active by default. If it's not, or if you want to switch back to the classic editor:

  1. In the management UI, select APIs > API Proxies.
  2. In the list of API Proxies, select the proxy you want to work on.
  3. Switch back and forth between the "Classic" and "New" versions by clicking the link in the upper right side of the window.

What are the main features of the UI?

This UI is where you:

  • View details about the proxy (Overview tab)
  • Build out the proxy flow with endpoints, conditional flows, and policies (Develop tab)
  • Debug proxies (Trace tab)
  • Track proxy performance and other analytics (Performance tab)

What's changed?

One of the biggest changes is that the Overview page displays read-only information, and you perform all proxy configuration on the Develop page. Also, the concept of "API resources" is being removed and replaced by the existing, more technically correct concept of "conditional flows".

Overview page

  • The Overview page is read-only.
  • The "New" menu is gone. This was used to add a New Resource. This functionality has been replaced by adding conditional flows on the Develop page.
  • Deployments - Same as classic version. Added "Status" column to display deployment status.
  • Resources - Replaced by "Proxy Endpoints" and "Target Endpoints" that list all the flows in the API proxy (PreFlow, PostFlow, and conditional flows, formerly called "API resources").
  • The Performance section has been moved to the new Performance tab.

Develop page

This is where all API configuration occurs, including conditional flows (formerly "API resources") and setting the target endpoint URL (in the Target Endpoints section).

  • The "New" menu replaced by "+" buttons in the left nav area.
    • Dialogs:
      • New Script: changed.
      • New Resource: removed.
      • New Conditional Flow: changed, but still lets you add conditional flows with different path and verb conditions.
      • New Endpoint: similar to classic, but you no longer can select the endpoint type. It's implied by the "+" button in the Proxy Endpoint or Target Endpoint sections.
  • Left Nav changes
    • New "+" action buttons to add policies, endpoints, conditional flows, and resource files (such as XSL, JavaScript, etc.).
    • Click the name of the API proxy to show the proxy.xml file. You can also change the proxy display name and description in this view.
    • Clicking flow icons jumps you around in the entire XML file in the code pane rather than just displaying a standalone snippet of XML.
    • In the Scripts section, the file type categories mirror the exact names of their parent folders on the file system when you download an API proxy.
  • The Navigator drives what's displayed in the editor. You must select an item in the Navigator to display it in the editor view and Property Inspector.
  • If you update a policy name or target endpoint, the information is automatically updated throughout the API proxy XML.
  • Search looks for filenames and file content (in text files).
  • The right-side Property Inspector has a new look & feel.

Trace page

  • No change.

Performance page

  • New - Replaces what was on the classic Overview page. 
  • A new "Configure" button lets you add URL patterns and verbs for analytics in each environment.

 

Help or comments?