Skip to content

Commit aed5cae

Browse files
authored
README updated
1 parent b760d6e commit aed5cae

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,16 @@ To work with [GraphQL](https://graphql.org/) features, i.e. **Type Definitions,
77

88
This Example works with [AWS HTTP API](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop.html) events.
99

10-
[//]: # (For faster response with the APIs [Redis](https://redis.io/) *caching* is used). For *session tracking* [JSON Web Token (JWT)](https://jwt.io/) is used.
10+
<!---
11+
For faster response with the APIs [Redis](https://redis.io/) *caching* is used.
12+
For *session tracking* [JSON Web Token (JWT)](https://jwt.io/) is used.
13+
-->
1114

1215
All *logs* for the function is kept in [AWS Cloudwatch](https://aws.amazon.com/cloudwatch/) i.e *persistent*.
1316

1417
To use the code in this example you **must** have an valid [AWS account](https://aws.amazon.com/account/) and necessary [AWS IAM](https://aws.amazon.com/iam/) roles and programmatic access to an user. You **must** have a [MongoDB Atlas](https://www.mongodb.com/docs/atlas/) account as well as an [AWS EC2](https://aws.amazon.com/ec2/) instance should be installed with [Redis](https://redis.io/).
1518

16-
[User Sticker App](https://github.com/anijitsahu/react-app-simple-user-sticker-app) is related to this application.
19+
1720

1821
## Features
1922
1. [AWS Lambda](https://aws.amazon.com/lambda/) function using [NodeJS](https://nodejs.org/en/docs/)
@@ -32,15 +35,21 @@ To use the code in this example you **must** have an valid [AWS account](https:/
3235
</ol>
3336

3437

38+
<!---
3539
6. For **session tracking** [JWT](https://jwt.io/) is used.
36-
7. [AWS HTTP API](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop.html) are using [AWS API GateWay](https://aws.amazon.com/api-gateway/)
40+
-->
41+
6. [AWS HTTP API](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop.html) are using [AWS API GateWay](https://aws.amazon.com/api-gateway/)
3742

38-
<ol start="8">
43+
<ol start="7">
3944
<li> All data is saved in <a href="https://www.mongodb.com/docs/atlas/">MongoDB Atlas</a> i.e. <i>persistent</i>
40-
<li> <strong>Caching</strong> is used for faster response in the APIs. <a href="https://redis.io/">Redis</a> is used for that purpose</li>
45+
<!--- <li> <strong>Caching</strong> is used for faster response in the APIs. <a href="https://redis.io/">Redis</a> is used for that purpose</li> -->
4146
<li> This APIs can also be consumed by any <b>Frontend Application</b>.</li>
47+
<li> To use <a href="https://graphql.org/">GraphQL</a> features <a href="https://www.apollographql.com/docs/apollo-server/">Apollo Server</a> is used
48+
<li> For the <i>Schema</i> generation <b>Type Definitions</b> are added. <b>Queries</b> are used for the <i>Reading</i> operations while <b>Mutations</b> are added for <i>Mutable</i> operations.
4249
</ol>
4350

51+
52+
4453
11. [NPM](https://www.npmjs.com/) dependencies are used for various purposes.
4554
12. **Custom Headers** are added with the response for *obvious security* reasons.
4655

@@ -71,21 +80,23 @@ $ serverless deploy
7180

7281
After successful deployment, you can invoke the deployed **functions / resolvers**.
7382

74-
However, to call using `httpApi/ GraphQL API` you can use any GraphQl Client like [Altair GraphQL Client](https://chrome.google.com/webstore/detail/altair-graphql-client/flnheeellpciglgpaodhkhmapeljopja?hl=en) with the `url` and *HTTP Verbs* as shown in Terminal after using `serverless deploy`.
83+
However, to call using [GraphQL](https://graphql.org/) API you can use any *supported* Client like [Altair GraphQL Client](https://chrome.google.com/webstore/detail/altair-graphql-client/flnheeellpciglgpaodhkhmapeljopja?hl=en) with the `url` and *HTTP Verbs* as shown in Terminal after using `serverless deploy`.
7584

7685
## API Listing
7786

78-
It should call necessary GraphQL APIs. Some of the API listing is given below
87+
API listing is given below, -
7988

8089
**GET** /url-of-the-deployed-lambda/graphql
8190

91+
Following *Queries* use the same URL mentioned above
92+
8293
```javascript
8394
query HelloQuery {
8495
hello
8596
}
8697
```
8798

88-
**GET** /url-of-the-deployed-lambda/graphql
99+
89100

90101
```javascript
91102
query FindBooksQuery {

0 commit comments

Comments
 (0)