typical-rest-server

module

v0.8.17 Latest Latest Go to latest Published: Jan 20, 2020 License: MIT

Details

Example of typical and scalable RESTful API Server for Go

Bash Snippet	Usage
`typical-rest-server`	Run the application
`typical-rest-server route`	Print available API Routes

Name	Type	Default	Required
APP_ADDRESS	string	:8089	Yes
PG_DBNAME	string		Yes
PG_HOST	string	localhost
PG_PASSWORD	string	pgpass	Yes
PG_PORT	int	5432
PG_USER	string	postgres	Yes
REDIS_DB	int	0
REDIS_DIAL_TIMEOUT	Duration	5s	Yes
REDIS_HOST	string	localhost	Yes
REDIS_IDLE_CHECK_FREQUENCY	Duration	1m	Yes
REDIS_IDLE_TIMEOUT	Duration	5m	Yes
REDIS_MAX_CONN_AGE	Duration	30m	Yes
REDIS_PASSWORD	string	redispass
REDIS_POOL_SIZE	int	20	Yes
REDIS_PORT	string	6379	Yes
REDIS_READ_WRITE_TIMEOUT	Duration	3s	Yes
SERVER_DEBUG	bool	false

Install Go (It is recommend to install via Homebrew brew install go)

Use ./typicalw run to build and run the project.

Use ./typicalw test to test the project.

Use ./typicalw release to make the release. Learn More

Bash Snippet	Usage
`./typicalw docker`	Docker utility
`./typicalw docker compose`	Generate docker-compose.yaml
`./typicalw docker up`	Spin up docker containers according docker-compose
`./typicalw docker down`	Take down all docker containers according docker-compose
`./typicalw docker wipe`	Kill all running docker container
`./typicalw readme`	Generate README Documentation
`./typicalw rails`	Rails-like generation
`./typicalw rails scaffold`	Generate CRUD API
`./typicalw rails repository`	Generate Repository from tablename
`./typicalw redis`	Redis Tool
`./typicalw redis console`	Redis Interactive
`./typicalw postgres`	Postgres Database Tool
`./typicalw postgres create`	Create New Database
`./typicalw postgres drop`	Drop Database
`./typicalw postgres migrate`	Migrate Database
`./typicalw postgres rollback`	Rollback Database
`./typicalw postgres seed`	Data seeding
`./typicalw postgres reset`	Reset Database
`./typicalw postgres console`	PostgreSQL Interactive

Path	Synopsis
app
config
controller
repository
service
cmd
typical-rest-server command
mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.
pkg
dbkit
echotest
railskit
typdocker
typpostgres
typrails
typrails/internal/tmpl
typreadme
typredis
typserver
typical