Skip to content

Latest commit

 

History

History
104 lines (71 loc) · 2.89 KB

README.md

File metadata and controls

104 lines (71 loc) · 2.89 KB
Raw

npm version

Gapi to GraphQL

Converts almost any Google Data API to a GraphQL API via the Google API Discovery Service

Limitations

  • Read only
  • No downloading (think Drive documents ... )

Supports 138 Google APIs!

Full list of APIs and their require() path

Usage

npm i gapi-to-graphql --save

Example on the server

index.mjs

import { gql, ApolloServer } from 'apollo-server'
import gapiToGraphQL from 'gapi-to-graphql'
import YouTubeAPI from 'gapi-to-graphql/google_apis/youtube-v3'

const { schema, resolvers } = gapiToGraphQL({ gapiAsJsonSchema: YouTubeAPI })

const server = new ApolloServer({
  typeDefs: gql`
    ${schema}
  `,
  resolvers
})

server.listen({ port: 3031 }).then(({ url }) => {
  console.log(`🚀  Server ready at ${url}`)
})

Run example with node --experimental-modules index.mjs

Query usage

{
  YoutubeApi(key: "YOUR_API_KEY") {
    search {
      list(q: "graphql", part: "snippet") {
        items {
          id {
            videoId
          }
          snippet {
            title
            thumbnails {
              default {
                url
              }
            }
          }
        }
      }
    }
  }
}

Live example YouTube Hunt (Client and Server)

temporarily down. Going to redploy to Heroku Soon!

GitHub: https://github.com/rlancer/yt-gql-example

UI: https://youtube-gql-example.appspot.com/

GraphiQL: https://youtube-gql-example.appspot.com/graphql

GraphiQL with a query: URL too long!

youtubehunt

FAQ

Should this API be exposed to web clients

Yes, but be sure to add API keys and sanitize other parameters via a middleware solution like https://www.npmjs.com/package/graphql-add-middleware

Can I use this in production

Yes, since all its doing is making API calls it's fairly safe to use in production if your use cases have been well tested in development.

Contributors

Pull requests welcome! Join the project on Collaborizm

License

gapi-to-graphql is MIT licensed.