Skip to content

AlexRodriguez-Freeverse/graphiql_gitbook

Repository files navigation

Integration of GraphiQL

Integration module for Gitbook

The main description is in the Gitbook documentation

There are several examples in the repo

For submitting the integration, you just need to run this command:

gitbook publish

After it, the command line will show the integration URL. Something like this:

🚀 Integration "GraphiQL" published
👉 https://app.gitbook.com/integrations/GraphiQL

When the URL is browsed, and logged in in Gitbook, it automatically add the integration in the designed space, the one used for creating the API_KEY.

For connecting the integration to the local code, this command is needed:

gitbook dev 0CbiPo9O1vg65a4rm24Q

That key is retrieved from the space UI. More info here

It is important to note that all the changes in the code are automatically pushed to Gitbook, except the ones in the gitbook-manifest.yaml

Format the query

Two steps are needed in order to fill the required URL in the add-on:

  • Paste the query in the editor and use the pretty print button
  • Copy the query and paste it here to build the required URL. The resulting URL is generated after clicking in the Encode for GraphiQL button.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published