Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/twreporter/go-api

Golang API
https://github.com/twreporter/go-api

golang mongodb mysql news oauth2 rest-api

Last synced: about 17 hours ago
JSON representation

Golang API

Awesome Lists containing this project

README 

        
# TWReporter's Golang Backend API



## Environment 

### Development



#### Go module

After [email protected] is released, go-api no longer needs to be developed within $GOPATH/src directory thanks to the go module support. Make sure your go version is [email protected] or higher to have full compatibility. You can clone to anywhere outside the $GOPATH as you wish.



```golang

$ git clone github.com/twreporter/go-api

$ cd go-api



// Run test

$ go test ./...



// Use makefile

make start

// Or

$ go run main.go



// Build server binaries

$ go build -o go-api

$ ./go-api

```



#### Deprecated

Please make sure that you install [Glide

  package manager](https://github.com/Masterminds/glide) in the environment. (Switch to [go module](https://github.com/golang/go/wiki/Modules) after v5.0.0)



```

cd $GOPATH/src/github.com/twreporter/go-api

glide install                           # Install packages and dependencies



// use Makefile

make start 

// or 

go run main.go                          # Run without live-reloading

```



### Production

```

go build

./go-api

```



## Dependencies Setup and Configurations

There are two major dependencies of go-api, one is MySQL database, 

another is MongoDB. 


MySQL DB stores membership data, which is related to users.


MongoDB stores news entities, which is the content that go-api provides.



### Install docker-compose

[docker-compose installation](https://docs.docker.com/compose/install/) 



### Start/Stop MySQL and MongoDB with default settings

```

// start MySQL and MongoDB

make env-up



// stop MySQL and MongoDB

make env-down

```



### Configure MySQL Connection

Copy `configs/config.example.json` and rename as `configs/config.json`.

Change `DBSettings` fields to connect to your own database, like following example.

```

  "DBSettings": {

    "Name":     "test_membership",

    "User":     "test_membership",

    "Password": "test_membership",

    "Address":  "127.0.0.1",

    "Port":     "3306"

  },

```



### Configure MongoDB Connection

Copy `configs/config.example.json` and rename as `configs/config.json`.

Change `MongoDBSettings` fields to connect to your own database, like following example.

```

  "MongoDBSettings": {

    "URL": "localhost",

    "DBName": "plate",

    "Timeout": 5

  },

```



### AWS SES Setup

Currently the source code sends email through AWS SES. 

If you want to send email through your AWS SES, the config with credentials is needed.



To get credentials, please go to [Identity and Access Management (IAM)](https://console.aws.amazon.com/iamv2/home?#/users) page and add new user. Note that you need to set user details as follows:

  - set user name

    - naming convention:  `ses-smtp-user.{YYYYMMDD}-develop`

  - select AWS access type: select `Access key - Programmatic access`



After creating a new user, remember to copy the `Access key ID` and `Secret access key` and put them in AWS SES config under `~/.aws/credentials`

```

[default]

aws_access_key_id = ${AWS_ACCESS_KEY_ID}

aws_secret_access_key = ${AWS_SECRET_ACCESS_KEY}

```



For more information, please refer to [this guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html). 



Otherwise, you have to change the `utils/mail.go` to integrate with your email service.



### OAuth Setup

- Google

  - go to [APIs & Services](https://console.developers.google.com/apis/credentials/oauthclient/505721902139-u57i4r21h1e0b9rhdqcehleb4b05fcsf.apps.googleusercontent.com?project=coastal-run-106202&authuser=0&pli=1)

  - copy  `Client ID` and `Client secret` 

  - edit `configs/config.go`

    ```

    oauth:

      google:

        id: $Client_ID

        secret: $Client_secret

    ```

- Facebook

  - go to [apps setting](https://developers.facebook.com/apps/760575077441512/settings/basic/)  - copy `App ID` and `App secret` 

  - edit `configs/config.go`

    ```

    oauth:

      facebook:

        id: $App_ID

        secret: $App_secret

    ```



### Database Migrations

Go-api integrates [go-migrate](https://github.com/golang-migrate/migrate) to do the schema version control. You can follow the instructions to install the cli from [here](https://github.com/golang-migrate/migrate/tree/master/cli).



To use Makefile, check following instruction:



Check Current Migration Version

```bash

$ make check-version

```



Upgrade Migration Version

```bash

# usage:

# make upgrade-schema UP=

#   UP: , if undefined, upgrade to latest number



# example: upgrade 4 versions

$ make upgrade-schema UP=4



# example: upgrade to latest version

$ make upgrade-schema

```



Downgrade Migration Version

```bash

# usage:

# make downgrade-schema DOWN=

#   DOWN: , if undefined, clear all migration



# example: downgrade 1 version

$ make downgrade-schema DOWN=1



# example: remove all migration

$ make downgrade-schema

```



Goto Certain Migration Version

```bash

# usage:

# make goto-schema SCHEMA_VERSION=

#   SCHEMA_VERSION: , if undefined, interactive prompt will ask for index in next line.



# example: goto version 3

$ make goto-schema SCHEMA_VERSION=3



# example: goto version 3

$ make goto-schema

$ 3

```



Force to Certain Migration Version

```bash

# usage:

# make force-schema SCHEMA_VERSION=

#   SCHEMA_VERSION: , if undefined, interactive prompt will ask for index in next line.



# notice:

#   migrations will not be executed if you use this function.

#   you can use this function to clean dirty state while development



# example: force to version 4

$ make force-schema SCHEMA_VERSION=4



# example: force to version 4

$ make force-schema

$ 4

```



Basic operations are listed below:



Create



```

# Create migration pair files up/down_000001_$FILE_NAME.$FILE_EXTENSION in $FILE_DIR

migrate create -ext $FILE_EXTENSION -dir $FILE_DIR -seq $FILE_NAME 

```



Up



```

# Upgrade to the latest version in migration directory

migrate -databsae $DATABASE_CONNECTION -path $MIGRATION_DIR up

```



Down (CAUTION)



```

# Remove all the existing versions change

migrate -database $DATABASE_CONNECTION -path $MIGRATION_DIR down

```



Goto



```

# Upgrade/Downgrade to the specific versions

migrate -database $DATABASE_CONNECTION -path $MIGRATION_DIR goto $VERSION

```



more details in [FAQ](https://github.com/golang-migrate/migrate/blob/master/FAQ.md) and [godoc](https://godoc.org/github.com/mattes/migrate)(old repo)



## Functional Testing

### Prerequisite

* Make sure the environment you run the test has a running `MySQL` server and `MongoDB` server



### How To Run Tests

```

// use Makefile

make test



// or



go test $(glide novendor)



// or print logs

go test -v $(glide novendor)

```



## API Document

See [https://twreporter.github.io/go-api/](https://twreporter.github.io/go-api/)



## License

Go-api is [MIT licensed](https://github.com/twreporter/go-api/blob/master/LICENSE)