Merge pull request #64 from orta/ex_schema

Add support + docs for exporting the GraphQLSchema

Author: alexisjanvier

README.md

@@ -530,6 +530,26 @@ app.use('/graphql', jsonGraphqlExpress(data));
 app.listen(PORT);
 ```
 
+## Schema Export
+
+You can also use the export `jsonSchemaBuilder` to get your own copy of the GraphQLSchema:
+
+In  node:
+```js
+import {graphql} from 'graphql';
+import {jsonSchemaBuilder} from 'json-graphql-server';
+
+const data = { };
+const schema = jsonSchemaBuilder(data);
+const query = `[...]`
+
+graphql(schema, query).then(result => {
+  console.log(result);
+});
+```
+
+Or available in the global scope when running on a client as `jsonSchemaBuilder`.
+
 ## Deployment
 
 Deploy with Heroku or Next.js.

src/client.js

@@ -1,7 +1,9 @@
 import GraphQLClientServer from './graphQLClientServer';
+import schemaBuilder from './schemaBuilder';
 
 if (typeof window !== 'undefined') {
     window.JsonGraphqlServer = GraphQLClientServer;
+    window.jsonSchemaBuilder = schemaBuilder;
 }
 
 export default GraphQLClientServer;

src/jsonGraphqlExpress.js

@@ -9,7 +9,7 @@ import schemaBuilder from './schemaBuilder';
  *
  * @example
  * import express from 'express';
- * import { jsonGraphqlExpress } from 'json-graphql-server';
+ * import jsonGraphqlExpress from 'json-graphql-server';
  *
  * const data = {
  *    "posts": [

src/node.js

@@ -1,3 +1,5 @@
 import jsonGraphqlExpress from './jsonGraphqlExpress';
+import schemaBuilder from './schemaBuilder';
 
+export const jsonSchemaBuilder = schemaBuilder;
 export default jsonGraphqlExpress;

src/schemaBuilder.js

@@ -3,6 +3,50 @@ import { printSchema } from 'graphql';
 import getSchemaFromData from './introspection/getSchemaFromData';
 import resolver from './resolver';
 
+/**
+ * Generates a GraphQL Schema object for your data
+ *
+ * @param {any} data
+ * @returns A GraphQL Schema
+ *
+ * @example
+ * import {graphql} from 'graphql';
+ * import {jsonSchemaBuilder} from 'json-graphql-server';
+ *
+ * const data = {
+ *    "posts": [
+ *        {
+ *            "id": 1,
+ *            "title": "Lorem Ipsum",
+ *            "views": 254,
+ *            "user_id": 123,
+ *        },
+ *        {
+ *            "id": 2,
+ *            "title": "Sic Dolor amet",
+ *            "views": 65,
+ *            "user_id": 456,
+ *        },
+ *    ],
+ *    "users": [
+ *        {
+ *            "id": 123,
+ *            "name": "John Doe"
+ *        },
+ *        {
+ *            "id": 456,
+ *            "name": "Jane Doe"
+ *        }
+ *    ],
+ * };
+ *
+ * const schema = jsonSchemaBuilder(data);
+ * const query = `[...]`
+ * graphql(schema, query).then(result => {
+ *   console.log(result);
+ * });
+ *
+ */
 export default data =>
     makeExecutableSchema({
         typeDefs: printSchema(getSchemaFromData(data)),