Importing GraphQL API Definition File

Procedure

1. Navigate to New API Definition > Import a file. The Import an API Definition pop-up window opens.

2. In the Import an API Definition window, provide the following values:

   1. In Schema Type, select GraphQL and click Choose file. In the system file selection dialog, select the file to upload.

      note

      Before uploading a GraphQL schema file, ensure your file type is .graphql, .gql, or .graphqls.

   2. In API Definition Name, enter the API definition name.

   3. In Public Endpoint Domain, select a public domain from the list.

   4. Optional: In Public Endpoint Subdomain, specify an optional subdomain for the public domain.

   5. Optional: In Backend Endpoint Domain, specify the domain name for the API call that will be sent to the Endpoint system that contains your data.

   6. In Organization, select an organization from the list.

   7. Click Preview.

   8. Click Save and continue.

      On successful API creation, the new API endpoint appears on the Endpoints:<your api name> page.

      

   9. On Endpoints:<your api name> page, click on the endpoint link in the Name column. This opens the Methods: <your api name> page. You can create a new method definition and view the endpoint configuration for your API in each of the tabs on this page.

      

Next Steps

On the Key & Method Detection page, configure the GRAPHQL API key and method settings. Refer to Configuring API Endpoint Key and Method Detection Settings for more information.