go-graphql-api-boilerplate's Introduction

Go GraphQL API Boilerplate

Stacks

Go
GraphQL : graphql-go
Querybuilder : goqu

Features

User Sign Up & Sign In with OAuth (Google, Kakao)
Change the Profile

How to Run

Initialize DB

Create a database using sql/create.sql (MYSQL)
Configure the db in db/db.go

// ConnectDB : connecting DB
func ConnectDB() (*DB, error) {
	db, err := sql.Open("mysql", "api:your_password$@/database_name?parseTime=true")

	if err != nil {
		panic(err)
	}

	// https://github.com/go-sql-driver/mysql/#important-settings
	db.SetConnMaxLifetime(time.Minute * 3)
	db.SetMaxOpenConns(10)
	db.SetConnMaxIdleTime(10)

	errPing := db.Ping()
	if errPing != nil {
		panic(err.Error())
	}

	qb := goqu.New("mysql", db)

	return &DB{qb}, nil
}

Make `.env` file

STAGE=PROD // PROD for production or else for debug
JWT_SECRET=my_secret
GOOGLE_CLIENT_ID=your_google_web_client_id
KAKAO_REST_API_KEY=your_kakao_rest_api_key
KAKAO_REDIRECT_URI=http://localhost:8280/oauth/kakao/redirect

Run the server

$ go run server.go

GraphQL Playground

Connect to http://localhost:8080

Authentication : JWT

You need to set the Http request headers Authorization: Bearer {JWT_token}

Usage

Sign In

mutation {
  signInGoogle(idToken: "12345678") {
    ok
    error
    token
  }
}

mutation {
  signInKakao(code: "12345678") {
    ok
    error
    token
  }
}

Change a Profile

mutation {
  changeProfile(nickname: "Go developer") {
    ok
    error
    user {
      id
      email
      nickname
      createdAt
      updatedAt
    }
  }
}

Get my profile

query {
  getMyProfile {
    ok
    error
    user {
      id
      email
      nickname
      createdAt
      updatedAt
    }
  }
}

go-graphql-api-boilerplate's People

Contributors

Stargazers

Watchers

go-graphql-api-boilerplate's Issues

use of context in main func

hi there, just a question about this context.Bakground() call in main.go

func main() {
	db, err := db.ConnectDB()
	if err != nil {
		panic(err)
	}

	defer db.Close()
        // what's this call for? doesnt seem to be used for anything
	context.Background()

doesnt seem to be doing anything. why is it there?

ADD Bearer in header authorization value

Resolvers structure & Authentication

Is having the resolvers organized in that manner the most organized approach? what happens when you start to have 50+ resolvers. Is there a way to better structure the folder?

Is there a way to have authentication required on some queries and not others, as well has having user groups. And require group membership for certain routes?

BUG/Security Issue - Password Returned if Password add to query

In its current state, the password will be returned if the password field is added to the query, this is considered a security issue and should not be the case.

Passwords should never be return, encrypted or clear-text.

Recommend Projects