Add GraphQL support

[rayshan]

Hello,

GraphQL is a query language created by Facebook for describing data requirements on complex application data models. It's frequently used with React and Relay.

References:
http://graphql.org/
IDE: https://github.com/graphql/graphiql

[tribou]

I would like to second this issue. Postman has an opportunity to communicate to an existing GraphQL API using the introspection query and provide auto-complete for queries similar to the existing GraphiQL implementation. Combined with Postman's existing feature-set of saved queries and environment management, it could make Postman my go-to app for testing during GraphQL API development.

May we get an update as to the consideration of this?

[a85]

@tribou We are super interested in extending Postman to things beyond HTTP but have been super swamped with the current workload. :(

[tribou]

@a85 I understand, and thank you for the kind response. A quick clarification... GraphQL can actually communicates with JSON over HTTP using POST calls. With this being an example GraphQL query:

{
  viewer(authToken: "12345") {
    users {
      id
      name
      phone
      status
      createdAt
      updatedAt
    }
  }
}

The resulting full example query using curl looks like this:

curl -XPOST http://localhost:8080/graphql \
  -d '{ "query": "{ viewer(authToken: \"12345\") { users { id name phone status createdAt updatedAt } } }", "variables": null }'

Consequently, I'm actually able to use Postman to test and save queries now. However, the awkward string formatting required to translate the GraphQL query into JSON is what makes it difficult...and provides an opportunity for Postman. 😄

[a85]

@tribou Awesome. We'll add this asap.

[hkgill]

+1

[alondahari]

+1

[daviskoh]

+1

[dh94]

+1

[a85]

Sorry about the delay on this folks. This got held up as we have been refactoring parts of the app to enable more modularization. GraphQL is high on our radar overall. I'll update the thread once we have more info to share. Thanks for your patience.

[DraganKovacevic]

Are we there yet?

[ultymike]

+1

[BenGale]

+1

[cdelgadob]

+1

[Strutsagget]

+1

[atalebagha]

+1

[stevenb9]

+1

[batjko]

@nithincscubet I don't think that would make sense, since GraphQL itself has no concept of file uploads yet.

[tribou]

@madebysid @numaanashraf @a85 I'd love to get an update on this feature. This issue has been open for a year and a half now; and with the proliferation of GraphQL, I would have expected more progress (or at least more communication).

I think you've got two incredible opportunities for Postman, and you don't need to try to tackle both at once:

1. Support the GraphQL syntax in Postman to send API calls
2. Implement the GraphQL introspection query to provide autocomplete

I would think that item 1 would be more quickly attainable and would actually alleviate most of the pain currently felt when trying to use GraphQL with Postman--just make it easy to type in a GraphQL query and automatically format it into the appropriate JSON for the API call. Item 2 is more for convenience and UX, which would obviously be a huge win and would keep more users in the Postman ecosystem than have them migrate to GraphiQL or similar. However, it doesn't address the current pain like item 1, so I could understand if item 2 needed to be delayed further.

Please, take a moment to provide us with an update or a link to the current progress. Thank you!

[sdnts]

@tribou This is definitely something we're looking into. I agree that supporting the GraphQL syntax should be quickly doable.
I'd also suggest looking at out roadmap, which we'll update with GraphQL status soon. Thanks for the patience! :)

[horacehylee]

+1

[batjko]

Just to add inspiration, the way Insomnia does it, is essentially what we're after here.
It even has automatic introspection, so works similarly to GraphiQL (though I haven't been able to make that one work when I briefly tried). But even without that, a simple GraphQL query editor would suffice to start.

[webmobiles]

yes I'm working well with Insomnia, option for variables; auth bearer, but sync for 5$ monthly, postman will be paid?

[consolibyte]

+1

[Fohlen]

This is a crucial tool for every 2017 and 2018 backend engineer. When can we expect that feature to be shipped?

[cdelgadob]

Indeed. Specially after Amazon’s native support for GraphQL with AWS AppSync - https://aws.amazon.com/es/appsync/

…

El 2 dic 2017, a las 14:17, Lennard Berger ***@***.***> escribió: This is an essential workflow for every 2017 backend engineer. When can we expect that feature to be shipped? — You are receiving this because you commented. Reply to this email directly, view it on GitHub, or mute the thread.

[dashmug]

They said it is slated for release in Q2. Unfortunately, they didn't tell us what year.

[numaanashraf]

Thanks for the patience everyone. We are putting the finishing touches on this and making sure that GraphQL requests work consistently in the various individual and team workflows supported by Postman's products, including the Postman App, Newman and Postman Monitors.

Here's a sneak peek of the latest internal build and you can expect the feature to land in Canary in few weeks.

[nixoncode]

Thanks for the patience everyone. We are putting the finishing touches on this and making sure that GraphQL requests work consistently in the various individual and team workflows supported by Postman's products, including the Postman App, Newman and Postman Monitors.

Here's a sneak peek of the latest internal build and you can expect the feature to land in Canary in few weeks.

This is actually Pretty Neat, Am excited to see it hit the stable release, Good work so far.

[Chris533]

Nice!

[john-osullivan]

Huge!! Very excited to help get my team onboarded once this is live 👍

…

On Mon, Apr 29, 2019, 23:47 Chris533 ***@***.***> wrote: Nice! — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#1669 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA5E3NNKR7SOOW6J4KO7D2LPS66ONANCNFSM4BY5OC4Q> .

[dashmug]

It's Q2 2019! Yehey!

[joelgetaction]

@numaanashraf thanks for this! I was delaying buying a team license for Postman because of its lack of GraphQL support but as soon as this is GA I will go ahead and buy! :-)

[dwiyatci]

I better start learning GraphQL now 😂

[jronak]

@codenirvana can you please expedite the release?

[buddylindsey]

Thanks for the patience everyone. We are putting the finishing touches on this and making sure that GraphQL requests work consistently in the various individual and team workflows supported by Postman's products, including the Postman App, Newman and Postman Monitors.

Here's a sneak peek of the latest internal build and you can expect the feature to land in Canary in few weeks.

How is that sending data? Is it going to allow for the multipart upload spec? Not having that has been a limitation of other tools. https://github.com/jaydenseric/graphql-multipart-request-spec

[liaotuo]

very good!

[shasti421]

Thanks for the patience everyone. We are putting the finishing touches on this and making sure that GraphQL requests work consistently in the various individual and team workflows supported by Postman's products, including the Postman App, Newman and Postman Monitors.

Here's a sneak peek of the latest internal build and you can expect the feature to land in Canary in few weeks.

Any update on availability in Canary?

[a85]

Folks, we are working on rolling this out to everyone soon. Please check out our blog post about schema support and the general introduction of "APIs" as an abstraction here meanwhile: https://blog.getpostman.com/2019/05/17/postman-7-1-create-apis-directly-within-the-postman-app/

Full GraphQL support looks like this:

[kamalaknn]

Hi everyone,

GraphQL support is now available on the canary channel - download here

This version supports

1. Sending GraphQL queries in request body as POST requests
2. Support for GraphQL variables
3. Creating APIs in Postman with GraphQL schema type
4. Query autocompletion integrated with user defined GraphQL schemas, Coming Soon!

Please give it a try and give us your feedback on the tracking thread on our community forum - here

[tristanMatthias]

@kamalaknn Thanks so much! This is amazing and much needed.

I'm getting an error when trying to generate collections from a schema.gql file. Thoughts?

[alfaproject]

Is there any particular reason you don't support GET requests? I know I can do POST, but some of our saved queries can be cached and therefore can be requested using GET (;

[kamalaknn]

Hey @tristanMatthias

Thanks giving it a try. We are still working on adding support for generating collections from GraphQL schemas - we'll update once they are released.

@alfaproject

We support sending the GraphQL queries in request bodies for GET(and all methods). Please find the screenshot below.

We do not yet support sending GraphQL queries as query parameters. Can you confirm which mechanism you are using?

[alfaproject]

Query parameters, so we are able to HTTP cache a full query

[ljdev1]

This is great! Thank you!

Quick Question: Will there be GraphQL Schema Docs presented and auto-completion / validation of queries / mutations against the GraphQL Server Schema (not a local schema), like GraphiQL client does?

[numaanashraf]

@ljdev1 In our first production release, we'ld have auto-completion of queries & mutations using schemas stored inside APIs in Postman. We are exploring ways to present schema docs and power auto-completion via introspection from server schemas.

[a85]

GraphQL support is out in production as part of the 7.2 release. More details to be posted on our blog soon at blog.getpostman.com. Closing this ticket now!

[galvesribeiro]

Looking for the blog post. I've made the update but I'm not able to use GraphQL on it yet :(

[yura3d]

Thanks for the update.
But in 7.2.0 I don't see 2 important things for GraphQL (or I don't know how to enable them): query check-up and auto-completion for remote GraphQL schemas, like they are made, for example, in Insomnia.

[kamalaknn]

Hey @yura3d

In Postman, GraphQL autocompletion is available through API schemas. You can find out how to use them here

[yura3d]

@kamalaknn thanks. But I'm on API development stage and its scheme is very often updated. So, changing the scheme in 2 places (Server and Postman) is not rational solution for me. I will wait for support of introspection, it is really helpful thing in GraphiQL or Insomnia.

[galvesribeiro]

@kamalaknn I'm pretty sure that is not what people are looking for. People are looking for replacing GraphiQL/GraphQL Playground with Postman. Forcing people to use a 3rd party thing to get the schema is no sense...

How difficult is to add a new option on the API to "Import from URL" where people can paste the GraphQL endpoint and it would use introspection to query it?

Also, once the schema is imported, we don't want to remember which fields the schema have... We want to press ctr/cmd+Space and see a list of available fields/operations on that schema based on the scope. Just like we do with the original tools.

Please make those changes asap so postman become usable with graphql...

[a85]

@galvesribeiro This is not the final version of the product nor is it trying to replace GraphiQL or other GraphQL tools. I am locking this thread as future feature requests can be filed elsewhere.