GraphQL

GraphQL query language allows the client to specify the structure of the requested data, and returns data from the server using the same structure. Such design ensures that only required data is retrieved, thus improving query efficiency.

Connect GraphQL API to OpenFlower

Follow these steps to connect to GraphQL APIs.

1. Click Data Sources on the OpenFlower homepage.

2. Click New data source on the upper right. This permission is restricted to workspace admins and developers.

3. Select APIs > GraphQL.

4. Configure general settings. At a minimum, input Name and the base URL of the API to connect to. Headers and Parameters are optional.

5. Configure Authentication Type.

6. Click Save.

You can also connect to a new GraphQL API data source when creating or editing queries in query library or query editor.

Authentication type

By default, the authentication type is None. You can configure it as Basic or Digest, which require Username and Password. If you need other authentication methods, contact our customer service on the homepage.

The following is an example of connecting to GitHub GraphQL API. Set the authentication type to None. Then, input the required information into Headers to complete the authentication. The key is "Authorization" and the value is "Bearer" + white space + YOUR_ACCESS_TOKEN. See Creating a personal access token for detailed information.

SSL Cert Verification

For detailed information, see SSL Cert Verification.

Forward cookies

For detailed information, see Forward cookies.

Create a GraphQL query

You can create GraphQL queries in two ways:

• add a new data source and then create a query

• create a query directly

Note that without creating a new data source, the GraphQL data source is not stored in your Data Sources and thus cannot be accessed to build other queries.

Create a query with a new data source

Follow the steps to add a new GraphQL data source first and then create a query.

1. Connect GraphQL API to access to.

2. In the query editor, click + New.

3. Select the added API in Data source.

4. Write a query.

5. Click ▶ Run.

For details about using GraphQL, reference Introduction to GraphQL.

The following GraphQL query searches the latest 20 closed issues in the repository octocat/Hello-World, and returns the title, URL, and the first 5 labels of each issue.

Create a query with predefined data source

Follow the steps to create a GraphQL query directly.

1. In the query editor, click + New.

2. Select GraphQL Query in Data sources. OpenFlower offers this built-in plain data source so that you can quickly create GraphQL queries without adding a new data source first.

3. Enter URL, Query, Variables, Parameters, and fill in other fields if needed.

4. Click ▶ Run.