Use Postman to test a service with GraphQL in AWS (AppSync, Apollo)

Question

I'm trying to call a service through Graphql with Postman. From my app (React) I can use all the services with no problem (so, they are running ok), but I want to test them alone with Postman.

I'm using AppSync, this is my configuration:

const AppSyncConfig = {
  url: environments.configAws.graphql.aws_appsync_graphqlEndpoint,
  region: environments.configAws.graphql.aws_appsync_region,
  auth: {
    type: AUTH_TYPE.API_KEY,
    apiKey: environments.configAws.graphql.aws_appsync_apiKey,
  }
};

The environments vars are this:

graphql: {
    aws_project_region: "us-east-1",

    aws_appsync_graphqlEndpoint: "https://XXXXXXXXXXXXX.appsync-api.us-east-1.amazonaws.com/graphql",
    aws_appsync_region: "us-east-1",
    aws_appsync_authenticationType: "API_KEY",
    aws_appsync_apiKey: "da2-XXXXXXXXXXXX"
}

And the app use this to make a query:

const client = new AWSAppSyncClient(AppSyncConfig, {
  link: createAppSyncLink({ ...AppSyncConfig,
    resultsFetcherLink: ApolloLink.from([
      setContext((request, previousContext) => ({
        headers: { ...previousContext.headers,
          Authorization: localStorage.getItem('token') ? localStorage.getItem('token') : ''
        }
      })),
      createHttpLink({
        uri: AppSyncConfig.url
      })
    ])
  })
});

const data_configs = client.readQuery({ query: query_configs });

In Postman I have this config, but I'm getting an error:

I took this code today, I haven't work before with Graphql (so neither with AppSync, ApolloLink, etc), but I ask in case it has a simple solution, or at least a hint for what should I check. Thanks.

score 18 · Answer 1 · answered Dec 11 '19 at 22:46

18

I believe the header name for the API KEY is not API_KEY but x-api-key.

answered Dec 11 '19 at 22:46

Ionut Trestian

5,473
2
20
29

score 12 · Answer 2 · answered Aug 30 '21 at 20:32

I was able to invoke my AWS Amplify GraphQL endpoint with Postman using the following steps:

Create a new Postman request
Set the type of request to 'POST'
Enter the API URL in the request URL
Add a header of 'x-api-key': {{API KEY}} in the Headers tab
Add a body of consisting of a well formed GraphQL query
Click Send

score 1 · Answer 3 · answered Jun 29 '21 at 07:29

1

Put "x-api-id" in the request header works for me.

answered Jun 29 '21 at 07:29

JES

21
1

score 1 · Answer 4 · edited May 16 '22 at 08:52

1

Here is the images which I have implemented in Postman. First image has header and other details, and in Second image check Raw Body Section.

edited May 16 '22 at 08:52

DharmanBot

1,066
2
6
10

answered May 16 '22 at 08:08

Mohsin Khan

131
1
1
10

score 1 · Answer 5 · answered Nov 04 '22 at 12:30

1

It's the screenshot for 'x-api-key' from the Authentication tab in Postman. Its type is API Key and it can be also used like this.

answered Nov 04 '22 at 12:30

afaik

56
4

Use Postman to test a service with GraphQL in AWS (AppSync, Apollo)

5 Answers5