Creating a GraphQL API by Importing an API from URL

Edit online

About this task

Let’s look at a sample scenario, where you are creating a GraphQL API, Star Wars API, by importing an API from URL.

Before you begin

Ensure that you have:

  • Manage APIs or Activate/Deactivate APIs functional privilege. If you are an Administrator, you would have this privilege by default.
  • A GraphQL API base URL to create an API using the importer. For example, you can use the base URL https://raw.githubusercontent.com/graphql/swapi-graphql/master/schema.graphql.

To create a GraphQL API by importing an API from URL

Procedure

  1. Click APIs in the title navigation bar.
  2. Click Create API.
  3. Select Import API from URL.
  4. Provide the URL as https://raw.githubusercontent.com/graphql/swapi-graphql/master/schema.graphql.
  5. Select Protected to make the API a protected API and provide the Username and Password.
  6. Provide a description for the API in the Description field.
  7. Type a name for the API name in the Name field. For example, Starwars_GraphQL_URL.
  8. Select GraphQL SDL from the Type dropdown menu
  9. Provide the version number as 1.0 in the Version field.
  10. Select the team as Administrator for which you want to assign the API in the Team field
    This field appears only when the Team feature is enabled. It displays only the teams that you are a part of.
    graphql api from url
  11. Click Create.
    A GraphQL API is created with the default Straight Through Routing policy.
  12. Click Edit to replace the Endpoint URI of the Straight Through Routing policy.
    For the API to work, you must replace the Endpoint URI of the default Straight Through Routing policy with the query string of the native API.
  13. Navigate to Policies > Routing > Straight Through Routing and replace the ${sys:query_string} alias in the Endpoint URI with the query string of the native API.
    Here, use the native API endpoint of the Star Wars API, that is, https://swapi-graphql.netlify.app/.netlify/functions/index.
  14. Click Activate.
  15. Click Yes in the confirmation dialog box.
    The API is now activated. The API Gateway endpoint is now available, and consumers can use this endpoint to invoke the API.

What to do next

Next Steps

Now that you have created the REST API, you must