Skip to content

Commit db9cbf2

Browse files
authored
Add GraphQL guide (#630)
* Including GraphQL API card * GraphQL guide boilerplate * GraphQL theme * Introduction * Running * Crafting getting started section * Adding images to the getting started * Including server customize * Your first query section * Remove server customize session * Adding objects section * Object Create Generic Mutation section * Class create mutation section * Finding objects section * Constraints, order and pagination sections * Updating objects section * Deleting an object section * Users boilerplate * Signing up section * Logging out section * Me query example * Learning more section * Update _includes/graphql/learning-more.md Co-Authored-By: Tom Fox <[email protected]> * Update _includes/graphql/users.md Co-Authored-By: Tom Fox <[email protected]> * Update _includes/graphql/users.md Co-Authored-By: Tom Fox <[email protected]>
1 parent 5cdc5c3 commit db9cbf2

File tree

18 files changed

+886
-40
lines changed

18 files changed

+886
-40
lines changed

_includes/graphql/getting-started.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Getting Started
2+
3+
[GraphQL](https://graphql.org/), developed by Facebook, is an open-source data query and manipulation language for APIs. In addition to the traditional [REST API](/rest/guide/), Parse Server automatically generates a GraphQL API based on your current application schema.
4+
5+
The easiest way to run the Parse GraphQL Server is using the CLI:
6+
7+
```bash
8+
$ npm install -g parse-server mongodb-runner
9+
$ mongodb-runner start
10+
$ parse-server --appId APPLICATION_ID --masterKey MASTER_KEY --databaseURI mongodb://localhost/test --mountGraphQL --mountPlayground
11+
```
12+
13+
Notes:
14+
* Run `parse-server --help` or refer to [Parse Server Options](https://parseplatform.org/parse-server/api/master/ParseServerOptions.html) for a complete list of Parse Server configuration options.
15+
* ⚠️ Please do not use `--mountPlayground` option in production as anyone could access your API Playground and read or change your application's data.
16+
17+
After running the CLI command, you should have something like this in your terminal:
18+
19+
<img alt="Parse GraphQL Server" data-echo="{{ '/assets/images/graphql/parse-graphql-server.png' | prepend: site.baseurl }}"/>
20+
21+
Since you have already started your Parse GraphQL Server, you can now visit [http://localhost:1337/playground](http://localhost:1337/playground) in your web browser to start playing with your GraphQL API.
22+
23+
<img alt="GraphQL Playground" data-echo="{{ '/assets/images/graphql/graphql-playground.png' | prepend: site.baseurl }}"/>

_includes/graphql/learning-more.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Learning More
2+
3+
If you look at the right side of your GraphQL Playground, you will see the DOCS and SCHEMA menus. They are automatically generated by analyzing your application schema and contain all operations that you can call for your application, including the automatic class queries and mutations. Please refer to them and learn more about everything that you can do with your Parse GraphQL API.
4+
5+
<img alt="GraphQL Docs" data-echo="{{ '/assets/images/graphql/graphql-docs.png' | prepend: site.baseurl }}"/>
6+
7+
Additionally, the [GraphQL Learn Section](https://graphql.org/learn/) is a very good source to start learning about the power of the GraphQL language.

0 commit comments

Comments
 (0)