Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

APIs and Proxies appear in this list. You can view details about the API or Proxy by clicking it. You can also set permissions on your API.

Known Issue

  • Lint issues occur when working with reference accounts, associated JAR files, and error pipelines in older versions of Snaplex.

    • Workaround - Update the Snaplex to the latest version to resolve the lint issue.

Create the API using Design First

...

  1. In the API Manager page, under the APIs & Proxies tab, click the add icon ( (blue star) ) and choose New API.

  2. In Create New API, choose Create from Existing Project and select the Project.

  3. Click Continue.

  4. In Create New API - Select Assets, select the types of assets you want to import to the new API. An Asset selected at the root level also imports the leaf-level Assets.

  5. Click Import and Continue.

  6. In Create New API - Details, fill in the details for the new API.

    • General Info

      • Name (Title). The name of the new API.

        The name must meet the following requirements:

        • Must be unique.

        • Must begin with alphanumeric characters A-Z, a-z, or 0-9.

        • Cannot contain the reserved keyword shared.

        • Cannot contain |, <, >, [, ], {, }, #, ?, /, and \.

        • Must be no more than 256 characters. If the name includes double-byte characters, the maximum length is shorter.

      • Description. A description of the new API.

      • Version. The version number for the first version of the API.
        Default: 1.0.
        Learn more: Managing Versions of Your APIs

      • Tags. Enter any tags associated with your API. You can create the tags as required. 

    • Endpoint Configuration » Path to Endpoint. (Read-only) The base path for the endpoint.

    • Server Configuration » Snaplex. The Snaplex to associate with the new API.

  7. Click Create.

Info
  • You receive an error message when the reference jar file is incorrect or when the asset is not found.

  • When you create an API from an existing project, the reference assets, including error pipelines and accounts, located in various folders or directories, as well as the associated jar files linked to the accounts, are automatically updated.

Create the API from a Git repository

...