yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-08-25 17:19:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(graphql): move to GraphQL Playground

Browse Source
This commit is contained in:
Johann Pinson 2018-05-15 16:03:22 +02:00
parent be148bd5c5
commit aeefa6156e
3 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/3.x.x/en/guides/graphql.md
View File

@ -10,7 +10,7 @@ To get started with GraphQL in your app, please install the plugin first. To do
strapi install graphql strapi install graphql
``` ```
Then, start your app and open your browser at [http://localhost:1337/graphiql](http://localhost:1337/graphiql). You should see the interface (GraphiQL) that will help you to write GraphQL query to explore your data. Then, start your app and open your browser at [http://localhost:1337/playground](http://localhost:1337/playground). You should see the interface (GraphQL Playground) that will help you to write GraphQL query to explore your data.
> Install the [ModHeader](https://chrome.google.com/webstore/detail/modheader/idgpnmonknjnojddfkpgkljpfnnfcklj/related) extension to set the `Authorization` header in your request > Install the [ModHeader](https://chrome.google.com/webstore/detail/modheader/idgpnmonknjnojddfkpgkljpfnnfcklj/related) extension to set the `Authorization` header in your request

21
packages/strapi-plugin-graphql/hooks/graphql/index.js
View File

@ -8,11 +8,12 @@
const _ = require('lodash'); const _ = require('lodash');
const path = require('path'); const path = require('path');
const glob = require('glob'); const glob = require('glob');
const { graphqlKoa, graphiqlKoa } = require('apollo-server-koa'); const { graphqlKoa } = require('apollo-server-koa');
const koaPlayground = require('graphql-playground-middleware-koa').default;
module.exports = strapi => { module.exports = strapi => {
return { return {
beforeInitialize: async function() { beforeInitialize: async function(){
// Try to inject this hook just after the others hooks to skip the router processing. // Try to inject this hook just after the others hooks to skip the router processing.
if (!_.get(strapi.config.hook.load, 'after')) { if (!_.get(strapi.config.hook.load, 'after')) {
_.set(strapi.config.hook.load, 'after', []); _.set(strapi.config.hook.load, 'after', []);
@ -68,14 +69,14 @@ module.exports = strapi => {
*/ */
// Set path with initial state. // Set path with initial state.
_.set(strapi.plugins.graphql, 'config._schema.graphql', { definition: ``, query: ``, type : {}, resolver: {} }); _.set(strapi.plugins.graphql, 'config._schema.graphql', { definition: '', query: '', type : {}, resolver: {} });
// Merge user API. // Merge user API.
Object.keys(strapi.api || {}).reduce((acc, current) => { Object.keys(strapi.api || {}).reduce((acc, current) => {
const { definition, query, type, resolver } = _.get(strapi.api[current], 'config.schema.graphql', {}); const { definition, query, type, resolver } = _.get(strapi.api[current], 'config.schema.graphql', {});
acc.definition += definition || ``; acc.definition += definition || '';
acc.query += query || ``; acc.query += query || '';
return _.merge(acc, { return _.merge(acc, {
type, type,
@ -87,8 +88,8 @@ module.exports = strapi => {
Object.keys(strapi.plugins || {}).reduce((acc, current) => { Object.keys(strapi.plugins || {}).reduce((acc, current) => {
const { definition, query, type, resolver } = _.get(strapi.plugins[current], 'config.schema.graphql', {}); const { definition, query, type, resolver } = _.get(strapi.plugins[current], 'config.schema.graphql', {});
acc.definition += definition || ``; acc.definition += definition || '';
acc.query += query || ``; acc.query += query || '';
return _.merge(acc, { return _.merge(acc, {
type, type,
@ -101,7 +102,7 @@ module.exports = strapi => {
const schema = strapi.plugins.graphql.services.graphql.generateSchema(); const schema = strapi.plugins.graphql.services.graphql.generateSchema();
if (_.isEmpty(schema)) { if (_.isEmpty(schema)) {
strapi.log.warn(`GraphQL schema has not been generated because it's empty`); strapi.log.warn('GraphQL schema has not been generated because it\'s empty');
return cb(); return cb();
} }
@ -111,9 +112,9 @@ module.exports = strapi => {
router.post(strapi.plugins.graphql.config.endpoint, async (ctx, next) => graphqlKoa({ schema, context: ctx })(ctx, next)); router.post(strapi.plugins.graphql.config.endpoint, async (ctx, next) => graphqlKoa({ schema, context: ctx })(ctx, next));
router.get(strapi.plugins.graphql.config.endpoint, async (ctx, next) => graphqlKoa({ schema, context: ctx })(ctx, next)); router.get(strapi.plugins.graphql.config.endpoint, async (ctx, next) => graphqlKoa({ schema, context: ctx })(ctx, next));
// Disable GraphiQL in production environment. // Disable GraphQL Playground in production environment.
if (strapi.config.environment !== 'production') { if (strapi.config.environment !== 'production') {
router.get('/graphiql', graphiqlKoa({ endpointURL: strapi.plugins.graphql.config.endpoint })); router.get('/playground', koaPlayground({ endpoint: strapi.plugins.graphql.config.endpoint}));
} }
strapi.app.use(router.middleware()); strapi.app.use(router.middleware());

1
packages/strapi-plugin-graphql/package.json
View File

@ -25,6 +25,7 @@
"apollo-server-koa": "^1.3.3", "apollo-server-koa": "^1.3.3",
"glob": "^7.1.2", "glob": "^7.1.2",
"graphql": "^0.13.2", "graphql": "^0.13.2",
"graphql-playground-middleware-koa": "^1.5.1",
"graphql-tools": "^2.23.1", "graphql-tools": "^2.23.1",
"graphql-type-json": "^0.2.0", "graphql-type-json": "^0.2.0",
"pluralize": "^7.0.0", "pluralize": "^7.0.0",