GraphQL API
Usage
To run the prototype:
- Install
npm install -g nodemon
- Install packages:
npm install
- Run:
nodemon server_small.js
The GraphQL API prototype will be running athttp://localhost:8081/
. To expore, you can use GraphiQL (an in-browser IDE for exploring GraphQL APIs), which can be found athttp://localhost:8081/graphql
.
To run the CLI tool:
- Install
npm install -g graphql-cli
cd
into a new dirgraphql init
(schema for this prototype =http://localhost:8081/graphql
)
To get the full graphql schema by the CLI tool:
- Run:
graphql get-schema
The result will be in./schema.graphql
To get the full schema definitions by a graphql introspection query:
- Install:
npm install -g graphdoq
- DESCRIBE HOW TO DO INTROSPECTION AND GET THE SCHEMA GENERATED DOCUMENTATION
- Run:
graphdoc -s ./introspection_result.json -o documentation
The result will be in the folderdocumentation
Documentation
The full documentation can be found in the Wiki.