| 1 | # cloudapi-gql
|
| 2 |
|
| 3 | [](https://opensource.org/licenses/MPL-2.0) [](http://travis-ci.org/joyent/cloudapi-gql)
|
| 4 |
|
| 5 |
|
| 6 | hapi plugin that exposes [CloudApi](https://apidocs.joyent.com/cloudapi/) through
|
| 7 | [GraphQL](http://graphql.org).
|
| 8 |
|
| 9 | ## Table of Contents
|
| 10 |
|
| 11 | * [Install](#install)
|
| 12 | * [Options](#options)
|
| 13 | * [Usage](#usage)
|
| 14 |
|
| 15 | ## Install
|
| 16 |
|
| 17 | ```
|
| 18 | npm install cloudapi-gql
|
| 19 | ```
|
| 20 |
|
| 21 | ## Options
|
| 22 |
|
| 23 | - `authStrategy`: name of the hapi auth strategy to use for `/graphql` route
|
| 24 | - `keyPath` private key file path for the key associated with Triton account
|
| 25 | - `keyId`: string in the form of `/${SDC_ACCOUNT}/keys/${SDC_KEY_ID}`
|
| 26 | - `apiBaseUrl`: cloud API base URL to connect to
|
| 27 |
|
| 28 |
|
| 29 | ## Usage
|
| 30 |
|
| 31 | ```js
|
| 32 | const server = new Hapi.Server();
|
| 33 | await server.register({ plugin: CloudApiGQL, options: { authStrategy, keyPath, keyId, apiBaseUrl } });
|
| 34 | ```
|
| 35 |
|
| 36 |
|
| 37 | ### Local development
|
| 38 |
|
| 39 | ```
|
| 40 | npm run dev
|
| 41 | ```
|
| 42 |
|
| 43 | * [GraphiQL](http://0.0.0.0:4000/graphiql)
|
| 44 | * [Graphidoc](http://0.0.0.0:4000/doc)
|
| 45 | * [Voyager](http://0.0.0.0:4000/voyager)
|
| 46 | * [Playground](http://0.0.0.0:4000/playground)
|
| 47 |
|
| 48 |  
|
| 49 |  
|
| 50 |
|
| 51 | ```
|
| 52 | npm run faker
|
| 53 | ```
|
| 54 |
|
| 55 | * [GraphQL Faker Interactive Editor](http://0.0.0.0:9002/editor)
|
| 56 | * [GraphQL Faker API](http://0.0.0.0:9002/graphql)
|
| 57 |
|
| 58 | 
|
| 59 |
|