Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/deno-libs/gql

☁ Universal GraphQL HTTP middleware for Deno
https://github.com/deno-libs/gql

deno graphql graphql-api graphql-server

Last synced: about 1 month ago
JSON representation

☁ Universal GraphQL HTTP middleware for Deno

Lists

README

        





[![nest badge][nest-badge]](https://nest.land/package/gql)
[![GitHub Workflow Status][gh-actions-img]][github-actions]
[![Codecov][cov-badge]][cov] [![][docs-badge]][docs]
[![][code-quality-img]][code-quality]

# gql

Universal and spec-compliant [GraphQL](https://www.graphql.com/) HTTP middleware
for Deno. Based on [graphql-http](https://github.com/graphql/graphql-http).

## Features

- ✨ Works with `Deno.serve` and [oak](https://github.com/oakserver/oak)
- ⚡
[GraphQL Playground](https://github.com/graphql/graphql-playground/tree/master/packages/graphql-playground-html)
integration (via `graphiql: true`)

## Get started

The simplest setup with `Deno.serve`:

```ts
import { GraphQLHTTP } from 'https://deno.land/x/[email protected]/mod.ts'
import { makeExecutableSchema } from 'npm:@graphql-tools/[email protected]'
import { gql } from 'https://deno.land/x/[email protected]/mod.ts'

const typeDefs = gql`
type Query {
hello: String
}
`

const resolvers = {
Query: {
hello: () => `Hello World!`,
},
}

const schema = makeExecutableSchema({ resolvers, typeDefs })

Deno.serve({
port: 3000,
onListen({ hostname, port }) {
console.log(`☁ Started on http://${hostname}:${port}`)
},
}, async (req) => {
const { pathname } = new URL(req.url)
return pathname === '/graphql'
? await GraphQLHTTP({
schema,
graphiql: true,
})(req)
: new Response('Not Found', { status: 404 })
})
```

Then run:

```sh
$ curl -X POST localhost:3000/graphql -d '{ "query": "{ hello }" }' -H "Content-Type: application/json"
{
"data": {
"hello": "Hello World!"
}
}
```

Or in the GraphQL Playground:

![image](https://user-images.githubusercontent.com/35937217/112218821-4133c800-8c35-11eb-984a-5c21fa71c229.png)

[docs-badge]: https://img.shields.io/github/v/release/deno-libs/gql?label=Docs&logo=deno&style=for-the-badge&color=DD3FAA
[docs]: https://doc.deno.land/https/deno.land/x/gql/mod.ts
[gh-actions-img]: https://img.shields.io/github/actions/workflow/status/deno-libs/gql/main.yml?branch=master&style=for-the-badge&logo=github&label=&color=DD3FAA&
[github-actions]: https://github.com/deno-libs/gql/actions
[cov]: https://coveralls.io/github/deno-libs/gql
[cov-badge]: https://img.shields.io/coveralls/github/deno-libs/gql?style=for-the-badge&color=DD3FAA
[nest-badge]: https://img.shields.io/badge/publushed%20on-nest.land-DD3FAA?style=for-the-badge
[code-quality-img]: https://img.shields.io/codefactor/grade/github/deno-libs/gql?style=for-the-badge&color=DD3FAA
[code-quality]: https://www.codefactor.io/repository/github/deno-libs/gql