Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrz1836/go-api
:rocket: Example api for inspiration on your new projects
https://github.com/mrz1836/go-api
api api-server caching go golang gomodule logging redis router sqlboiler
Last synced: 4 months ago
JSON representation
:rocket: Example api for inspiration on your new projects
- Host: GitHub
- URL: https://github.com/mrz1836/go-api
- Owner: mrz1836
- License: mit
- Created: 2019-08-17T17:10:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T10:37:12.000Z (10 months ago)
- Last Synced: 2024-05-01T15:38:35.362Z (9 months ago)
- Topics: api, api-server, caching, go, golang, gomodule, logging, redis, router, sqlboiler
- Language: Go
- Homepage:
- Size: 3.04 MB
- Stars: 9
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# go-api
> Example API with support for common implementations
[](https://github.com/mrz1836/go-api/releases)
[](https://github.com/mrz1836/go-api/actions)
[](https://goreportcard.com/report/github.com/mrz1836/go-api)
[](https://golang.org/)
[](https://github.com/sponsors/mrz1836)
[](https://mrz1818.com/?tab=tips&af=go-api)
## Table of Contents
- [Installation](#installation)
- [Documentation](#documentation)
- [Examples & Tests](#examples--tests)
- [Benchmarks](#benchmarks)
- [Code Standards](#code-standards)
- [Usage](#usage)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [License](#license)
## Installation
**1)** **go-api** requires [Go](https://golang.org/doc/devel/release.html#policy), [Redis](https://redis.io/) and [MySQL](https://www.mysql.com/) with no password set
```shell script
go get -u github.com/mrz1836/go-api
make install
```
**2)** Run the API
```shell script
make run
"starting Go API server..."
```
_Test your connection to the api_
```shell script
curl -X GET 'http://localhost:3000'
"Welcome to the Go API!"
```
## Documentation
View the generated [documentation](https://pkg.go.dev/github.com/mrz1836/go-api)
[](https://pkg.go.dev/github.com/mrz1836/go-api)
### Features
- Combination of powerful Go packages all-in-one API solution
- The fastest router: Julien Schmidt's [httprouter](https://github.com/julienschmidt/httprouter)
- The best redis cache package: Gary Burd's [Redigo](https://github.com/gomodule/redigo)
- Powerful database ORM: VolatileTech's [SQLBoiler](https://github.com/volatiletech/sqlboiler)
- Database migration: Pressly's [Goose](https://github.com/pressly/goose)
- Ready for development or production use
- Cache dependency management via [go-cache](https://github.com/mrz1836/go-cache)
- Supports different incoming load balancer setups (/health)
- Logging each request and whenever you need logs (remote via [LogEntries](https://logentries.com/))
- Flexible environment & configuration management using [viper](https://github.com/spf13/viper)
- Built-in scheduler for any cron jobs or delayed tasks
- Powerful and easy emailing with support for [Postmark](https://postmarkapp.com), [Mandrill](https://mandrillapp.com), [AWS SES](https://aws.amazon.com/ses/) and [SMTP](https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol)
Package Dependencies
- [cron](https://github.com/robfig/cron/v3) - Run cron jobs with ease
- [go-api-router](https://github.com/mrz1836/go-api-router) - Fast and lightweight router
- [go-cache](https://github.com/mrz1836/go-cache) - Redis caching made easy
- [go-logger](https://github.com/mrz1836/go-logger) - Local or remote logging
- [go-mail](https://github.com/mrz1836/go-mail) - Email using multiple providers
- [go-sanitize](https://github.com/mrz1836/go-sanitize) - Clean data effortlessly
- [goose](https://github.com/pressly/goose) - Database migration
- [ozzo-validation](https://github.com/go-ozzo/ozzo-validation) - Extensible data validation
- [SQLBoiler](https://github.com/volatiletech/sqlboiler) - Powerful database ORM & model generation
- [viper](https://github.com/spf13/viper) - Go configuration with fangs
Library Deployment
[goreleaser](https://github.com/goreleaser/goreleaser) for easy binary or library deployment to GitHub and can be installed via: `brew install goreleaser`.
The [.goreleaser.yml](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/goreleaser).
Use `make release-snap` to create a snapshot version of the release, and finally `make release` to ship to production.
Makefile Commands
View all `makefile` commands
```shell script
make help
```
List of all current commands:
```text
all Runs multiple commands
clean Remove previous builds and any test cache data
clean-mods Remove all the Go mod cache
coverage Shows the test coverage
db Creates a fresh database
diff Show the git diff
env Creates a fresh database
flush-redis Wipe out all data in redis (requires redli)
generate Runs the go generate command in the base of the repo
godocs Sync the latest tag with GoDocs
help Show this help message
install Install the application
install Run the Custom installation
install-go Install the application (Using Native Go)
lint Run the golangci-lint application (install if not found)
release Full production release (creates release in Github)
release Runs common.release then runs godocs
release-snap Test the full release (build binaries)
release-test Full production test release (everything except deploy)
replace-version Replaces the version in HTML/JS (pre-deploy)
run Runs the application
run-examples Runs all the examples
schema Run the Model/schema generation
tag Generate a new tag and push (tag version=0.0.0)
tag-remove Remove a tag if found (tag-remove version=0.0.0)
tag-update Update an existing tag to current commit (tag-update version=0.0.0)
test Runs lint and ALL tests
test-ci Runs all tests via CI (exports coverage)
test-ci-no-race Runs all tests via CI (no race) (exports coverage)
test-ci-short Runs unit tests via CI (exports coverage)
test-no-lint Runs just tests
test-short Runs vet, lint and tests (excludes integration tests)
test-unit Runs tests and outputs coverage
uninstall Uninstall the application (and remove files)
update-linter Update the golangci-lint package (macOS only)
vet Run the Go vet application
```
Model Generation
Update the `reset_api_database.sql` if you have issues running the model tests
```sql
GRANT ALL ON `dynamic-database-name-generated-from-sql-boiler`.* to 'apiDbTestUser'@'%';
```
Rebuilding the generated models/schema from the database schema:
```shell script
make schema
```
Clear local redis and reload the database
```shell script
make db
make flush-redis
```
Environment Variables
All environment variables are referenced in the [config](config/config.go).
Edit the [`scripts/set_env.sh`](scripts/set_env.sh) file and modify the environment variables - IE:
```shell script
export API_SERVER_PORT=3000
```
## Examples & Tests
All unit tests and examples run via [GitHub Actions](https://github.com/tonicpow/go-paymail/actions) and
uses [Go version 1.19.x](https://golang.org/doc/go1.19). View the [configuration file](.github/workflows/run-tests.yml).
Run all tests (including integration tests)
```shell script
make test
```
Run tests (excluding integration tests)
```shell script
make test-short
```
## Benchmarks
Run the Go benchmarks:
```shell script
make bench
```
## Code Standards
Read more about this Go project's [code standards](.github/CODE_STANDARDS.md).
## Usage
(Coming soon: Examples!)
## Maintainers
| [
](https://github.com/mrz1836) |
|:------------------------------------------------------------------------------------------------:|
| [MrZ](https://github.com/mrz1836) |
## Contributing
View the [contributing guidelines](.github/CONTRIBUTING.md) and please follow the [code of conduct](.github/CODE_OF_CONDUCT.md).
### How can I help?
All kinds of contributions are welcome :raised_hands:!
The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:.
You can also support this project by [becoming a sponsor on GitHub](https://github.com/sponsors/mrz1836) :clap:
or by making a [**bitcoin donation**](https://mrz1818.com/?tab=tips&af=go-sanitize) to ensure this journey continues indefinitely! :rocket:
## License
[](LICENSE)