A project of api graphql for a fictitious ecommerce (Zoas Store)

It used in the project:

• Lang: Python3.7
• Framework: Flask
• Graphql: Graphene Python
• ORM: SqlAlchemy
• Database: PostgreSQL 11
• StyleGuide: Black + Flask8
• Type check: Mypy
• Git hook: pre-commit
• Test: pytest
• CI: Travis
• Coverage: Coveralls

This version is only for tests 🚧, not for production

It still has some enhancements to do 🔥

Create a virtual env and install the dependencies of project

Run app in development mode (api running on: localhost:5000/graphql)

Install dependencies of requirements file

Upgrade dependencies and install them

Run tests

Run tests with coverage

Run the app with gunicorn

Generate the flaskr/graphqlr/schema.graphql file

Run the black and flake8

The environment variables used are:

• POSTGRES_USER
• POSTGRES_PASSWORD
• POSTGRES_DB
• POSTGRES_PORT
• POSTGRES_HOST

/graphql

To see the full schema auto-generated go to schema.graphql, it is as a documentation for api.

type Mutations {
  createCart(input: CreateCartInput!): CreateCartPayload
  deleteCart(input: DeleteCartInput!): DeleteCartPayload
  putProductToCart(input: PutProductToCartInput!): PutProductToCartPayload
  removeProductOfCart(input: RemoveProductOfCartInput!): RemoveProductOfCartPayload
  payCart(input: PayCartInput!): PayCartPayload
}

type Query {
  cart: [ProductCart]
  product(id: ID!): Product
  products(before: String, after: String, first: Int, last: Int): ProductConnection
  node(id: ID!): Node
}

A custom error come in the format:

An additional code field in the error object

{
  "errors": [
    {
      "message": "The product quantity must be greater than zero and less than total",
      "code": "INVALID_PRODUCT_QUANTITY"
    }
  ],
  "data": {
    "putProductToCart": null
  }
}

1. Get products of store

curl localhost:3000/graphql \
-H "Content-Type: application/json" \
-d @- << EOF
{
    "query":
    "query {
       products(first: 5){
         pageInfo {
           hasNextPage
         }
         edges{
           cursor
           node {
             title
             price
             id
           }
         }
       }
    }"
}
EOF

Getting the 5 first items

This query products is a Relay Connection

2. Create a cart (session of user)

curl localhost:3000/graphql \
-c "zoas.cookie" \
-H "Content-Type: application/json" \
-d @- << EOF
{
    "query":
    "mutation {
       createCart(input: { clientMutationId: \"b5e27614-8ee4-47ad-b1b6-60417d41e91c\" }){
         confirmation
         clientMutationId
       }
    }"
}
EOF

For all mutations you must pass a clientMutationId conforms Relay Input Object Mutation

It will create a session for the user creating a cookie

The browser handle it automatically, but the curl command not made this, then use -c "zoas.cookie" to create a cookie and -b "zoas.cookie" to use the cookie

All operations using cart you must send the cookie (The browser do it automatically)

3. Put a product in the cart

curl localhost:3000/graphql \
-b "zoas.cookie" \
-H "Content-Type: application/json" \
-d @- << EOF
{
    "query":
    "mutation {
       putProductToCart(input: {
         clientMutationId: \"c6e24c6d-d12a-419f-9ad7-d41b81debd04\",
         id: \"UHJvZHVjdDox\",
         quantity: 4
       }){
         payload {
            title
            description
         }
         clientMutationId
       }
    }"
}
EOF

4. Get the products of cart

curl localhost:3000/graphql \
-b "zoas.cookie" \
-H "Content-Type: application/json" \
-d @- << EOF
{
    "query":
    "query {
       cart {
         id
         title
         description
         price
       }
    }"
}
EOF

docker-compose build

docker-compose up

API Running on: localhost:3000/graphql

Access it to do interactive graphql queries

This version is not for production

by @jeovazero