|
| 1 | +# Aws Apollo Tools |
| 2 | + |
| 3 | +[](https://nodejs.org/en/blog/release/v8.10.0/) |
| 4 | + |
| 5 | + |
| 6 | +## Table of Contents |
| 7 | + |
| 8 | +* [Prerequisites](#prerequisites) |
| 9 | +* [Getting Started](#getting-started) |
| 10 | +* [Usage](#usage) |
| 11 | + * [LambdaRequest](#lambdarequest) |
| 12 | + * [HttpRequest](#httprequest) |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | +## Prerequisites |
| 17 | + |
| 18 | +in `serverless.yml` |
| 19 | +```yml |
| 20 | +... |
| 21 | +provider: |
| 22 | + ... |
| 23 | + environment: |
| 24 | + SLS_STAGE: ${self:provider.stage} |
| 25 | + iamRoleStatements: |
| 26 | + - Effect: Allow |
| 27 | + Action: |
| 28 | + - execute-api:* |
| 29 | + Resource: '*' |
| 30 | +... |
| 31 | +``` |
| 32 | + |
| 33 | +## Getting Started |
| 34 | + |
| 35 | +* Run `yarn add @nutshelllab/aws-apollo-tools` |
| 36 | +* `import * from '@nutshelllab/aws-apollo-tools'` |
| 37 | + |
| 38 | +## Usage |
| 39 | + |
| 40 | +### LambdaRequest |
| 41 | + |
| 42 | +`import graphqlLambdaRequest from '@nutshelllab/aws-apollo-tools/lambda-request'` |
| 43 | + |
| 44 | +```js |
| 45 | +const request = gql` |
| 46 | + query getItem($id: ID!) { |
| 47 | + getItem(id: $id) { |
| 48 | + id |
| 49 | + } |
| 50 | + } |
| 51 | +` |
| 52 | + |
| 53 | +const variables = { |
| 54 | + id: '110e8400-e29b-11d4-a716-446655440000' |
| 55 | +} |
| 56 | + |
| 57 | +const test = await graphqlLambdaRequest({ |
| 58 | + lambdaName: 'my-lambda-name', |
| 59 | + region: 'eu-west-1', |
| 60 | + request, |
| 61 | + variables |
| 62 | +}) |
| 63 | + |
| 64 | +``` |
| 65 | + |
| 66 | +#### Options |
| 67 | + |
| 68 | +|name|required|type|info| |
| 69 | +|---|---|---|---|---| |
| 70 | +|lambdaName|true|string|The lambda endpoint must provide an apollo server| |
| 71 | +|region|true|string| | |
| 72 | +|request|true|string|It must be a GraphQL query [graphql-tag](https://github.com/apollographql/graphql-tag#readme)| |
| 73 | +|variables|false|object| | |
| 74 | +|headers|false|object| | |
| 75 | + |
| 76 | +### HttpRequest |
| 77 | + |
| 78 | +`import graphqlHttpRequest from '@nutshelllab/aws-apollo-tools/http-request'` |
| 79 | + |
| 80 | +```js |
| 81 | +const request = gql` |
| 82 | + query getItem($id: ID!) { |
| 83 | + getItem(id: $id) { |
| 84 | + id |
| 85 | + } |
| 86 | + } |
| 87 | +` |
| 88 | + |
| 89 | +const variables = { |
| 90 | + id: '110e8400-e29b-11d4-a716-446655440000' |
| 91 | +} |
| 92 | + |
| 93 | +const test = await graphqlHttpRequest({ |
| 94 | + uri: 'https://my-apollo-server-endpoint.com', |
| 95 | + region: 'eu-west-1', |
| 96 | + request, |
| 97 | + variables, |
| 98 | + signed: true |
| 99 | +}) |
| 100 | + |
| 101 | +``` |
| 102 | + |
| 103 | +#### Options |
| 104 | + |
| 105 | +|name|required|type|info| |
| 106 | +|---|---|---|---|---| |
| 107 | +|uri|true|string|The http endpoint must provide an apollo server| |
| 108 | +|region|true|string| | |
| 109 | +|request|true|string|It must be a GraphQL query [graphql-tag](https://github.com/apollographql/graphql-tag#readme)| |
| 110 | +|signed|false|bool|Setting to `true` enable aws signature v4, be sure that your http endpoint as `authorizer: aws_iam`| |
| 111 | +|variables|false|object| | |
| 112 | +|headers|false|object| | |
0 commit comments