Skip to content

Latest commit

 

History

History
111 lines (76 loc) · 10.3 KB

README.md

File metadata and controls

111 lines (76 loc) · 10.3 KB
Raw

Go Restful API Boilerplate

GoDoc Badge GoReportCard Badge

Easily extendible RESTful API boilerplate aiming to follow idiomatic go and best practice.

The goal of this boiler is to have a solid and structured foundation to build upon on.

Any feedback and pull requests are welcome and highly appreciated. Feel free to open issues just for comments and discussions.

Features

The following feature set is a minimal selection of typical Web API requirements:

  • Configuration using viper
  • CLI features using cobra
  • PostgreSQL support including migrations using bun
  • Structured logging with Logrus
  • Routing with chi router and middleware
  • JWT Authentication using lestrrat-go/jwx with example passwordless email authentication
  • Request data validation using ozzo-validation
  • HTML emails with go-mail

Start Application

  • Clone and change into this repository

Local

  • Create a postgres database and set environment variables for your database accordingly if not using below defaults
  • Run the application to see available commands: go run main.go
  • Run all migrations from database/migrate folder: go run main.go migrate
  • Run the application with command serve: go run main.go serve

Using Docker Compose

  • First start the database only: docker compose up -d postgres
  • Once initialize the database by running all migrations in database/migrate folder: docker compose run server ./main migrate
  • Start the api server: docker compose up

API Routes

Authentication

For passwordless login following routes are available:

Path Method Required JSON Header Description
/auth/login POST email the email you want to login with (see below)
/auth/token POST token the token you received via email (or printed to stdout if smtp not set)
/auth/refresh POST Authorization: "Bearer refresh_token" refresh JWTs
/auth/logout POST Authorizaiton: "Bearer refresh_token" logout from this device

Example API

Besides /auth/the API provides two main routes /api/ and /admin/*, as an example to separate application and administration context. The latter requires to be logged in as administrator by providing the respective JWT in Authorization Header.

Check routes.md for a generated overview of the provided API routes.

Client API Access and CORS

The server is configured to serve a Progressive Web App (PWA) client from ./public folder (this repo only serves an example index.html, see below for a demo PWA client to put here). In this case enabling CORS is not required, because the client is served from the same host as the api.

If you want to access the api from a client that is served from a different host, including e.g. a development live reloading server with below demo client, you must enable CORS on the server first by setting environment variable ENABLE_CORS=true on the server to allow api connections from clients served by other hosts.

Demo client application

For demonstration of the login and account management features this API serves a demo Vue.js PWA. The client's source code can be found here. Build and put it into the api's ./public folder, or use the live development server (requires CORS enabled).

Outgoing emails containing the login token will be print to stdout if no valid email smtp settings are provided by environment variables (see table below). If EMAIL_SMTP_HOST is set but the host can not be reached the application will exit immediately at start.

Use one of the following bootstrapped users for login:

TODO: deploy somewhere else... A deployed version can also be found on Heroku

Testing

Package auth/pwdless contains example api tests using a mocked database. Run them with: go test -v ./...

Environment Variables

By default viper will look at ./dev.env for a config file. Setting your config as Environment Variables is recommended as by 12-Factor App.

Name Type Default Description
PORT string localhost:3000 http address (accepts also port number only for heroku compability)
LOG_LEVEL string debug log level
LOG_TEXTLOGGING bool false defaults to json logging
DB_DSN string postgres://postgres:postgres@localhost:5432/postgres?sslmode=disable database dsn connection string
AUTH_LOGIN_URL string http://localhost:3000/login client login url as sent in login token email
AUTH_LOGIN_TOKEN_LENGTH int 8 length of login token
AUTH_LOGIN_TOKEN_EXPIRY time.Duration 11m login token expiry
AUTH_JWT_SECRET string random jwt sign and verify key - value "random" creates random 32 char secret at startup (and automatically invalidates existing tokens on app restarts, so during dev you might want to set a fixed value here)
AUTH_JWT_EXPIRY time.Duration 15m jwt access token expiry
AUTH_JWT_REFRESH_EXPIRY time.Duration 1h jwt refresh token expiry
EMAIL_SMTP_HOST string email smtp host (if set and connection can't be established then app exits)
EMAIL_SMTP_PORT int email smtp port
EMAIL_SMTP_USER string email smtp username
EMAIL_SMTP_PASSWORD string email smtp password
EMAIL_FROM_ADDRESS string from address used in sending emails
EMAIL_FROM_NAME string from name used in sending emails
ENABLE_CORS bool false enable CORS requests