Property name mappings for migration from REST API to GraphQL

GraphQL Admin API Troubleshooting
,
1

Hi there,

I’m currently reviewing the documentation for migrating our application from the Shopify REST API to the GraphQL equivalent queries and mutations. I noticed in the REST API documentation each resource contains equivalent GraphQL property names:
I.e, app_id in REST is app in GraphQL

image
image572×462 43.9 KB

Is there a way to somehow query or fetch all of these direct mappings between the REST and GraphQL version of each resource? Or a community driven effort or library that does that? If so, it would greatly expedite our migration and add a source of validation to our efforts.

From my interpretation of how it’s presented in the documentation, right now the intention is to manually hop between documentation pages and the GraphiQL Explorer to build these new GraphQL equivalent queries of the existing REST calls, is that correct? Or are there tools that expedite this that I’m not aware about?

Thanks in advance.

2

Hi,

Are you looking for one page that would list every REST endpoints and there equivalents (ordered by resource type)? If so, I don’t think this currently exists but I do agree this would be useful to quickly view every possible endpoint/ operation. I’ll flag this to the dev docs team here.

There’s no specific tooling that will automate the process of building and implementing GraphQL operations - so you will need to rely on the documentation (and the .dev assistant), as well as the GraphiQL app for testing.