mirror of https://github.com/encode/starlette.git
Add graphiql support
This commit is contained in:
Tom Christie
parent
9ff01e887f
commit
c0f9f60ae9
|
|
@ -20,7 +20,7 @@ schema = graphene.Schema(query=Query)
|
||||||
|
|
||||||
|
|
||||||
app = Starlette()
|
app = Starlette()
|
||||||
app.add_route('/', GraphQLApp(schema=schema))
|
app.add_route('/', GraphQLApp(schema=schema), methods=['GET', 'POST'])
|
||||||
```
|
```
|
||||||
|
|
||||||
## Sync or Async executors
|
## Sync or Async executors
|
||||||
|
|
@ -51,5 +51,5 @@ schema = graphene.Schema(query=Query)
|
||||||
|
|
||||||
|
|
||||||
app = Starlette()
|
app = Starlette()
|
||||||
app.add_route('/', GraphQLApp(schema=schema, executor=AsyncioExecutor()))
|
app.add_route('/', GraphQLApp(schema=schema, executor=AsyncioExecutor()), methods=['GET', 'POST'])
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,10 @@
|
||||||
from starlette import status
|
from starlette import status
|
||||||
from starlette.responses import PlainTextResponse, Response, JSONResponse
|
from starlette.responses import PlainTextResponse, Response, JSONResponse, HTMLResponse
|
||||||
from starlette.requests import Request
|
from starlette.requests import Request
|
||||||
from starlette.types import ASGIInstance, Receive, Scope, Send
|
from starlette.types import ASGIInstance, Receive, Scope, Send
|
||||||
import asyncio
|
import asyncio
|
||||||
import functools
|
import functools
|
||||||
|
import json
|
||||||
import typing
|
import typing
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
|
@ -29,11 +30,14 @@ class GraphQLApp:
|
||||||
|
|
||||||
async def asgi(self, receive: Receive, send: Send, scope: Scope) -> None:
|
async def asgi(self, receive: Receive, send: Send, scope: Scope) -> None:
|
||||||
request = Request(scope, receive=receive)
|
request = Request(scope, receive=receive)
|
||||||
response = await self.handler(request)
|
response = await self.handle_graphql(request)
|
||||||
await response(receive, send)
|
await response(receive, send)
|
||||||
|
|
||||||
async def handler(self, request: Request) -> Response:
|
async def handle_graphql(self, request: Request) -> Response:
|
||||||
if request.method == "GET":
|
if request.method == "GET":
|
||||||
|
if "text/html" in request.headers.get("Accept", ""):
|
||||||
|
return await self.handle_graphiql(request)
|
||||||
|
|
||||||
data = request.query_params # type: typing.Mapping[str, typing.Any]
|
data = request.query_params # type: typing.Mapping[str, typing.Any]
|
||||||
|
|
||||||
elif request.method == "POST":
|
elif request.method == "POST":
|
||||||
|
|
@ -95,3 +99,142 @@ class GraphQLApp:
|
||||||
)
|
)
|
||||||
loop = asyncio.get_event_loop()
|
loop = asyncio.get_event_loop()
|
||||||
return await loop.run_in_executor(None, func, query)
|
return await loop.run_in_executor(None, func, query)
|
||||||
|
|
||||||
|
async def handle_graphiql(self, request: Request) -> Response:
|
||||||
|
text = GRAPHIQL.replace("{{REQUEST_PATH}}", json.dumps(request.url.path))
|
||||||
|
return HTMLResponse(text)
|
||||||
|
|
||||||
|
|
||||||
|
GRAPHIQL = """
|
||||||
|
<!--
|
||||||
|
* Copyright (c) Facebook, Inc.
|
||||||
|
* All rights reserved.
|
||||||
|
*
|
||||||
|
* This source code is licensed under the license found in the
|
||||||
|
* LICENSE file in the root directory of this source tree.
|
||||||
|
-->
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<style>
|
||||||
|
body {
|
||||||
|
height: 100%;
|
||||||
|
margin: 0;
|
||||||
|
width: 100%;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
#graphiql {
|
||||||
|
height: 100vh;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<!--
|
||||||
|
This GraphiQL example depends on Promise and fetch, which are available in
|
||||||
|
modern browsers, but can be "polyfilled" for older browsers.
|
||||||
|
GraphiQL itself depends on React DOM.
|
||||||
|
If you do not want to rely on a CDN, you can host these files locally or
|
||||||
|
include them directly in your favored resource bunder.
|
||||||
|
-->
|
||||||
|
<link href="//cdn.jsdelivr.net/npm/graphiql@0.12.0/graphiql.css" rel="stylesheet"/>
|
||||||
|
<script src="//cdn.jsdelivr.net/npm/whatwg-fetch@2.0.3/fetch.min.js"></script>
|
||||||
|
<script src="//cdn.jsdelivr.net/npm/react@16.2.0/umd/react.production.min.js"></script>
|
||||||
|
<script src="//cdn.jsdelivr.net/npm/react-dom@16.2.0/umd/react-dom.production.min.js"></script>
|
||||||
|
<script src="//cdn.jsdelivr.net/npm/graphiql@0.12.0/graphiql.min.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="graphiql">Loading...</div>
|
||||||
|
<script>
|
||||||
|
/**
|
||||||
|
* This GraphiQL example illustrates how to use some of GraphiQL's props
|
||||||
|
* in order to enable reading and updating the URL parameters, making
|
||||||
|
* link sharing of queries a little bit easier.
|
||||||
|
*
|
||||||
|
* This is only one example of this kind of feature, GraphiQL exposes
|
||||||
|
* various React params to enable interesting integrations.
|
||||||
|
*/
|
||||||
|
// Parse the search string to get url parameters.
|
||||||
|
var search = window.location.search;
|
||||||
|
var parameters = {};
|
||||||
|
search.substr(1).split('&').forEach(function (entry) {
|
||||||
|
var eq = entry.indexOf('=');
|
||||||
|
if (eq >= 0) {
|
||||||
|
parameters[decodeURIComponent(entry.slice(0, eq))] =
|
||||||
|
decodeURIComponent(entry.slice(eq + 1));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
// if variables was provided, try to format it.
|
||||||
|
if (parameters.variables) {
|
||||||
|
try {
|
||||||
|
parameters.variables =
|
||||||
|
JSON.stringify(JSON.parse(parameters.variables), null, 2);
|
||||||
|
} catch (e) {
|
||||||
|
// Do nothing, we want to display the invalid JSON as a string, rather
|
||||||
|
// than present an error.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// When the query and variables string is edited, update the URL bar so
|
||||||
|
// that it can be easily shared
|
||||||
|
function onEditQuery(newQuery) {
|
||||||
|
parameters.query = newQuery;
|
||||||
|
updateURL();
|
||||||
|
}
|
||||||
|
function onEditVariables(newVariables) {
|
||||||
|
parameters.variables = newVariables;
|
||||||
|
updateURL();
|
||||||
|
}
|
||||||
|
function onEditOperationName(newOperationName) {
|
||||||
|
parameters.operationName = newOperationName;
|
||||||
|
updateURL();
|
||||||
|
}
|
||||||
|
function updateURL() {
|
||||||
|
var newSearch = '?' + Object.keys(parameters).filter(function (key) {
|
||||||
|
return Boolean(parameters[key]);
|
||||||
|
}).map(function (key) {
|
||||||
|
return encodeURIComponent(key) + '=' +
|
||||||
|
encodeURIComponent(parameters[key]);
|
||||||
|
}).join('&');
|
||||||
|
history.replaceState(null, null, newSearch);
|
||||||
|
}
|
||||||
|
// Defines a GraphQL fetcher using the fetch API. You're not required to
|
||||||
|
// use fetch, and could instead implement graphQLFetcher however you like,
|
||||||
|
// as long as it returns a Promise or Observable.
|
||||||
|
function graphQLFetcher(graphQLParams) {
|
||||||
|
// This example expects a GraphQL server at the path /graphql.
|
||||||
|
// Change this to point wherever you host your GraphQL server.
|
||||||
|
return fetch({{REQUEST_PATH}}, {
|
||||||
|
method: 'post',
|
||||||
|
headers: {
|
||||||
|
'Accept': 'application/json',
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
},
|
||||||
|
body: JSON.stringify(graphQLParams),
|
||||||
|
credentials: 'include',
|
||||||
|
}).then(function (response) {
|
||||||
|
return response.text();
|
||||||
|
}).then(function (responseBody) {
|
||||||
|
try {
|
||||||
|
return JSON.parse(responseBody);
|
||||||
|
} catch (error) {
|
||||||
|
return responseBody;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
// Render <GraphiQL /> into the body.
|
||||||
|
// See the README in the top level of this module to learn more about
|
||||||
|
// how you can customize GraphiQL by providing different values or
|
||||||
|
// additional child elements.
|
||||||
|
ReactDOM.render(
|
||||||
|
React.createElement(GraphiQL, {
|
||||||
|
fetcher: graphQLFetcher,
|
||||||
|
query: parameters.query,
|
||||||
|
variables: parameters.variables,
|
||||||
|
operationName: parameters.operationName,
|
||||||
|
onEditQuery: onEditQuery,
|
||||||
|
onEditVariables: onEditVariables,
|
||||||
|
onEditOperationName: onEditOperationName
|
||||||
|
}),
|
||||||
|
document.getElementById('graphiql')
|
||||||
|
);
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
"""
|
||||||
|
|
|
||||||
|
|
@ -74,6 +74,12 @@ def test_graphql_invalid_field():
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def test_graphiql_get():
|
||||||
|
response = client.get("/", headers={"accept": "text/html"})
|
||||||
|
assert response.status_code == 200
|
||||||
|
assert "<!DOCTYPE html>" in response.text
|
||||||
|
|
||||||
|
|
||||||
class ASyncQuery(graphene.ObjectType):
|
class ASyncQuery(graphene.ObjectType):
|
||||||
hello = graphene.String(name=graphene.String(default_value="stranger"))
|
hello = graphene.String(name=graphene.String(default_value="stranger"))
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue