一个样板/入门项目，用于使用 Go、Fiber 和 PostgreSQL 快速构建 RESTful API。受到 Express 样板的启发。
该应用程序具有许多内置功能，例如使用 JWT 和 Google OAuth2 进行身份验证、请求验证、单元和集成测试、docker 支持、API 文档、分页等。有关更多详细信息，请查看下面的功能列表。
克隆存储库：
git clone --depth 1 https://github.com/indrayyana/go-fiber-boilerplate.git cd go-fiber-boilerplate rm -rf ./.git
安装依赖项：
go mod tidy
设置环境变量：
cp .env.example .env # open .env and modify the environment variables (if needed)
本地运行：
make start
或者通过实时重新加载运行：
air
注意：
确保您已安装 Air。
看 ？如何安装Air
测试：
# run all tests make tests # run all tests with gotestsum format make testsum # run test for the selected function name make tests-TestUserModel
码头工人：
# run docker container make docker # run all tests in a docker container make docker-test
检查：
# run lint make lint
大摇大摆：
# generate the swagger documentation make swagger
迁移：
# Create migration make migration-<table-name> # Example for table users make migration-users
# run migration up in local make migrate-up # run migration down in local make migrate-down # run migration up in docker container make migrate-docker-up # run migration down all in docker container make migrate-docker-down
环境变量可以在.env文件中找到并修改。它们具有以下默认值：
# server configuration # Env value : prod || dev APP_ENV=dev APP_HOST=0.0.0.0 APP_PORT=3000 # database configuration DB_HOST=postgresdb DB_USER=postgres DB_PASSWORD=thisisasamplepassword DB_NAME=fiberdb DB_PORT=5432 # JWT # JWT secret key JWT_SECRET=thisisasamplesecret # Number of minutes after which an access token expires JWT_ACCESS_EXP_MINUTES=30 # Number of days after which a refresh token expires JWT_REFRESH_EXP_DAYS=30 # Number of minutes after which a reset password token expires JWT_RESET_PASSWORD_EXP_MINUTES=10 # Number of minutes after which a verify email token expires JWT_VERIFY_EMAIL_EXP_MINUTES=10 # SMTP configuration options for the email service SMTP_HOST=email-server SMTP_PORT=587 SMTP_USERNAME=email-server-username SMTP_PASSWORD=email-server-password EMAIL_FROM=support@yourapp.com # OAuth2 configuration GOOGLE_CLIENT_ID=yourapps.googleusercontent.com GOOGLE_CLIENT_SECRET=thisisasamplesecret REDIRECT_URL=http://localhost:3000/v1/auth/google-callback
src\ |--config\ # Environment variables and configuration related things |--controller\ # Route controllers (controller layer) |--database\ # Database connection & migrations |--docs\ # Swagger files |--middleware\ # Custom fiber middlewares |--model\ # Postgres models (data layer) |--response\ # Response models |--router\ # Routes |--service\ # Business logic (service layer) |--utils\ # Utility classes and functions |--validation\ # Request data validation schemas |--main.go # Fiber app
要查看可用 API 列表及其规范，请运行服务器并在浏览器中访问 http://localhost:3000/v1/docs。
此文档页面是使用控制器文件中作为注释编写的 Swag 定义自动生成的。
看到了吗？声明性注释格式。
可用路线列表：
授权路由:
POST /v1/auth/register - 注册
POST /v1/auth/login - 登录
POST /v1/auth/logout - 注销
POST /v1/auth/refresh-tokens - 刷新身份验证令牌
POST /v1/auth/forgot-password - 发送重置密码电子邮件
POST /v1/auth/reset-password - 重置密码
POST /v1/auth/send-verification-email - 发送验证电子邮件
POST /v1/auth/verify-email - 验证电子邮件
GET /v1/auth/google - 使用 google 帐户登录
用户路线:
POST /v1/users - 创建用户
GET /v1/users - 获取所有用户
GET /v1/users/:userId - 获取用户
PATCH /v1/users/:userId - 更新用户
DELETE /v1/users/:userId - 删除用户
该应用程序包含自定义错误处理机制，可以在 src/utils/error.go 文件中找到。
它还利用 Fiber-Recover 中间件从处理程序堆栈中可能发生的任何恐慌中正常恢复，防止应用程序意外崩溃。
错误处理进程发送以下格式的错误响应：
{
"code": 404,
"status": "error",
"message": "Not found"
}
Fiber 使用 Fiber.NewError() 提供自定义错误结构，您可以在其中指定响应代码和消息。然后可以从代码的任何部分返回此错误，Fiber 的 ErrorHandler 将自动捕获它。
例如，如果您尝试从数据库检索用户但未找到该用户，并且想要返回 404 错误，则代码可能如下所示：
func (s *userService) GetUserByID(c *fiber.Ctx, id string) {
user := new(model.User)
err := s.DB.WithContext(c.Context()).First(user, "id = ?", id).Error
if errors.Is(err, gorm.ErrRecordNotFound) {
return fiber.NewError(fiber.StatusNotFound, "User not found")
}
}
Request data is validated using Package validator. Check the documentation for more details on how to write validations.
The validation schemas are defined in the src/validation directory and are used within the services by passing them to the validation logic. In this example, the CreateUser method in the userService uses the validation.CreateUser schema to validate incoming request data before processing it. The validation is handled by the Validate.Struct method, which checks the request data against the schema.
import (
"app/src/model"
"app/src/validation"
"github.com/gofiber/fiber/v2"
)
func (s *userService) CreateUser(c *fiber.Ctx, req validation.CreateUser) (*model.User, error) {
if err := s.Validate.Struct(&req); err != nil {
return nil, err
}
}
To require authentication for certain routes, you can use the Auth middleware.
import (
"app/src/controllers"
m "app/src/middleware"
"app/src/services"
"github.com/gofiber/fiber/v2"
)
func SetupRoutes(app *fiber.App, u services.UserService, t services.TokenService) {
userController := controllers.NewUserController(u, t)
app.Post("/users", m.Auth(u), userController.CreateUser)
}
These routes require a valid JWT access token in the Authorization request header using the Bearer schema. If the request does not contain a valid access token, an Unauthorized (401) error is thrown.
Generating Access Tokens:
An access token can be generated by making a successful call to the register (POST /v1/auth/register) or login (POST /v1/auth/login) endpoints. The response of these endpoints also contains refresh tokens (explained below).
An access token is valid for 30 minutes. You can modify this expiration time by changing the JWT_ACCESS_EXP_MINUTES environment variable in the .env file.
Refreshing Access Tokens:
After the access token expires, a new access token can be generated, by making a call to the refresh token endpoint (POST /v1/auth/refresh-tokens) and sending along a valid refresh token in the request body. This call returns a new access token and a new refresh token.
A refresh token is valid for 30 days. You can modify this expiration time by changing the JWT_REFRESH_EXP_DAYS environment variable in the .env file.
The Auth middleware can also be used to require certain rights/permissions to access a route.
import (
"app/src/controllers"
m "app/src/middleware"
"app/src/services"
"github.com/gofiber/fiber/v2"
)
func SetupRoutes(app *fiber.App, u services.UserService, t services.TokenService) {
userController := controllers.NewUserController(u, t)
app.Post("/users", m.Auth(u, "manageUsers"), userController.CreateUser)
}
In the example above, an authenticated user can access this route only if that user has the manageUsers permission.
The permissions are role-based. You can view the permissions/rights of each role in the src/config/roles.go file.
If the user making the request does not have the required permissions to access this route, a Forbidden (403) error is thrown.
Import the logger from src/utils/logrus.go. It is using the Logrus logging library.
Logging should be done according to the following severity levels (ascending order from most important to least important):
import "app/src/utils"
utils.Log.Panic('message') // Calls panic() after logging
utils.Log.Fatal('message'); // Calls os.Exit(1) after logging
utils.Log.Error('message');
utils.Log.Warn('message');
utils.Log.Info('message');
utils.Log.Debug('message');
utils.Log.Trace('message');
Note:
API request information (request url, response code, timestamp, etc.) are also automatically logged (using Fiber-Logger).
Linting is done using golangci-lint
See ? How to install golangci-lint
To modify the golangci-lint configuration, update the .golangci.yml file.
Contributions are more than welcome! Please check out the contributing guide.
If you find this boilerplate useful, consider giving it a star! ⭐
The full source code is available at the GitHub link below:
https://github.com/indrayyana/go-fiber-boilerplate
以上是使用 Go Fiber 构建 RESTful API：受 Express 启发的样板的详细内容。更多信息请关注PHP中文网其他相关文章！
