Creating API Definitions

An API definition is your starting point for managing an API in Cloud API Management. It is a set of configurable properties that specify the function of an API within Traffic Manager and how to route and handle requests for that API.

note

Only an Administrator or API Manager role can create or manage API definitions. Make sure you have one of these roles assigned in your area to access the API definitions page.

API Definition Options

API definitions can be created in four ways. Review the options below to choose the approach that fits your situation:

Option	Best for	Compatible with
Import a file	You already have an API spec saved locally.	OpenAPI, GraphQL
Import from a URI	You have a hosted API spec or GraphQL schema available at a URL.	OpenAPI, GraphQL
Create manually	You are building a new API or do not have an existing spec.	REST, SOAP, JSON-RPC, XML-RPC, and OTHER
Import from Boomi Platform	Your API is already deployed as a Platform API Service.	Boomi Platform APIs

tip

If you are not sure which method to use, Create manually is the most flexible starting point, you can always update the definition later.

Creating an API Definition

Procedure

1. On the Cloud API Management dashboard Get Started page, click API Definitions.

   Or

   Navigate to Design > APIs. This opens the Manage your APIs with API Definitions page.

2. Click New API Definition and select your preferred creation option. Each option opens a dedicated workflow:

   • Import a file:

     • OpenAPI file: Refer to Importing OpenAPI Definition File for more information.

     • GraphQL file: Refer to Importing GraphQL API Definition File for more information.

   • Import from a URI:

     • OpenAPI URI: Refer to Importing OpenAPI Definition from a URI for more information.

     • GraphQL URI: Refer to Importing GraphQL API Definition from a URI for more information.

   • Create manually: Refer to Creating API Definition manually for more information.

   • Import API from Boomi Platform: Refer to Importing API from Boomi Platform for more information.

Next Steps

After creating the API definition, configure it further to make it functional.

• Create an endpoint to define where the API receives traffic.

  You can also manage and view other endpoint settings, such as API Definition Settings, Security Settings, Error Sets, Interactive Documentation Access Control, Performance Acceleration, API History, and Client Usage Report.

• Create a method to specify the operations available on each endpoint for the API and have fine-grained control over your API traffic calls.

  You can also manage and view other method settings of an endpoint, such as Domains & Traffic Routing Settings, Key & Method Detection, Security Settings, Performance Acceleration, Cross-Origin Resource Sharing, Call Transformations, Load Balancing & Domains, Scheduled Maintenance, More Settings, and Client Usage Report.