typical-rest-server

module
v0.8.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 22, 2019 License: MIT

README

Typical-RESTful-Server

Example of typical and scalable RESTful API Server for Go

Prerequisite

  1. Install Go or brew install go

Run

Use ./typicalw run to compile and run local development. Lear more athere

Configuration

Server
Key Type Default Required Description
SERVER_DEBUG True or False false
PostgresDatabase
Key Type Default Required Description
PG_DBNAME String true
PG_USER String postgres true
PG_PASSWORD String pgpass true
PG_HOST String localhost
PG_PORT Integer 5432
Redis
Key Type Default Required Description
REDIS_HOST String localhost true
REDIS_PORT String 6379 true
REDIS_PASSWORD String redispass
REDIS_DB Integer 0
REDIS_POOL_SIZE Integer 20 true
REDIS_DIAL_TIMEOUT Duration 5s true
REDIS_READ_WRITE_TIMEOUT Duration 3s true
REDIS_IDLE_TIMEOUT Duration 5m true
REDIS_IDLE_CHECK_FREQUENCY Duration 1m true
REDIS_MAX_CONN_AGE Duration 30m true

Release Distribution

Use ./typicalw release to make the release. You can find the binary at release folder. Learn more athere

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL