go-api

README

go-api

go-api is a simple example API with support for common implementations

Table of Contents

• Installation
• Documentation
• Examples & Tests
• Benchmarks
• Code Standards
• Usage
• Maintainers
• Contributing
• License

Installation

Prerequisite Applications:

• MySQL or MariaDB with no password set
• Redis

1. go-api requires a supported release of Go and dep.

$ go get -u github.com/mrz1836/go-api
$ go get -u github.com/pressly/goose/cmd/goose
$ go get -u -t github.com/volatiletech/sqlboiler
$ go get -u github.com/volatiletech/sqlboiler/drivers/sqlboiler-mysql

1. Set your environment variables (or add to your bash profile):

$ cd ../go-api
$ . scripts/set_env.sh

1. Setup a fresh database (if you don't have one already)

$ . scripts/setup_db.sh

1. Run the API!

$ go run cmd/application/main.go

    starting Go API server...

Test your connection to go-api

$ curl -X GET 'http://localhost:3000'

  Welcome to the Go API!

Managing Dependencies

Updating dependencies in go-api:

$ cd ../go-api
$ dep ensure -update -v

Managing Environment Variables

All environment variables are referenced in the config.

Edit the scripts/set_env.sh file and modify the environment variables - IE:

export API_SERVER_PORT=3000

Managing Model Generation

Update the reset_api_database.sql if you have issues running the model tests

GRANT ALL ON `dynamic-database-name-generated-from-sql-boiler`.* to 'apiDbTestUser'@'%';

Rebuilding the generated models/schema from the database schema:

$ cd ../go-api
$ . scripts/rebuild_models.sh

Clear local redis and reload the database

$ . scripts/setup_db.sh && . scripts/flush_redis.sh

Package Dependencies

• go-api-router - Fast and lightweight router
• go-cache - Redis caching made easy
• go-logger - Local or remote logging
• go-sanitize - Clean data effortlessly
• go-mail - Email via multiple providers
• goose - Database migration
• ozzo-validation - Extensible data validation
• viper - Go configuration with fangs
• SQLBoiler - Powerful database ORM & model generation
• cron - Scheduler to run cron jobs and task

Documentation

You can view the generated documentation here.

Features

• Combination of powerful Go packages all-in-one API solution
• The fastest router: Julien Schmidt's httprouter
• The best redis cache package: Gary Burd's Redigo
• Powerful database ORM: VolatileTech's SQLBoiler
• Database migration: Pressly's Goose
• Ready for development or production use
• Cache dependency management via go-cache
• Supports different incoming load balancer setups (/health)
• Logging each request and whenever you need logs (remote via LogEntries)
• Flexible environment & configuration management using viper
• Built-in scheduler for any cron jobs or delayed tasks
• Powerful and easy emailing with support for Postmark, Mandrill, AWS SES and SMTP

Examples & Tests

All unit tests and examples run via Travis CI and uses Go version 1.13.x. View the deployment configuration file.

Run all tests (including integration tests)

$ cd ../go-api
$ go test ./... -v

Run tests (excluding integration tests)

$ cd ../go-api
$ go test ./... -v -test.short

View and run the examples:

$ cd ../go-api/examples
$ go run examples.go

Benchmarks

Run the Go benchmarks:

$ cd ../go-api
$ go test -bench . -benchmem

Code Standards

Read more about this Go project's code standards.

Usage

View the examples

Maintainers

@MrZ

Contributing

View the contributing guidelines and follow the code of conduct.

Support the development of this project 🙏

License