Creating an API by Importing an API from a URL

Edit online

About this task

Importing an API from a URL helps you to quickly create an API by retrieving its definition from a remote location. This method is useful when the API specification is hosted online and can be accessed directly without manual file uploads. By providing the URL, you can fetch the API definition, such as an OpenAPI or Swagger document, and generate the corresponding API configuration.

Procedure

  1. From the home page, select an existing project. If no project exists, create a new project.
    The project opens in the Development tab.
  2. In the quick access page, click Add an API > Load.
    The Load API from URL page is displayed.
  3. On the Load API from URL page, enter the API URL.
    For example, https://api.example.com/v1/orders.
  4. Provide the following details:
    • Secure endpoint. If the API URL requires authentication, select the Secure endpoint checkbox and provide the username and password to access the API.
    • API name. Provide a name for the API.
    • Namespace. Define a domain for the API to avoid conflicts with other APIs.
    • API version. Specify the version of the API to manage changes over time. The default value is 1.0.
    • API type. The API type is set to REST by default. Only REST APIs are supported.
    • Maturity state. Indicate the API's development stage, such as Draft, Published, or Deprecated.
    • API grouping. Organize related APIs under a common group for better management.
    • Tags. Add labels to categorize the API for improved search and filtering.
  5. Click Create.
    Two files are created:
    • An API file with kind: api.
    • An API specification file.

What to do next

  1. Author policies. Define and apply policies to manage security, rate limit, caching, and other API behaviors. For more information, see Author policies.
  2. Deploy the API. Publish the API to the gateway and make it accessible for consumers. For more information, see Deploy an API to webMethods API Gateway.
  3. Test the API. Verify that endpoints work as expected. For more information, see Testing a deployed API.