
作为一名软件工程师,我热衷于持续学习和技能提升,探索各种软件解决方案。我决定整合以下工具来构建一个新的API:
- OpenAPI:用于API规范定义。
- oapi-codegen:根据OpenAPI规范生成服务器代码。
- Testify:用于编写简洁的测试用例。
- Codecov:用于代码覆盖率分析。
- Docker:用于容器化部署。
- PostgreSQL:作为数据库后端。
- GORM:ORM框架(出于学习和探索的目的)。
- Flyway:用于数据库迁移管理。
- Kubernetes:用于容器编排。
- Terraform:用于基础设施即代码。
- Caddy(可能):作为反向代理。
API规范
我从一个简单的用户模型开始,定义了OpenAPI规范:
components:
schemas:
user:
type: object
properties:
id:
type: string
example: 123
readonly: true
email:
type: string
example: me@example.com
writeonly: true
name:
type: string
example: alice
这个规范用于/users POST请求,返回201 (Created)状态码,并使用自定义JSON对象描述400 (Bad Request)错误。
代码生成
我利用oapi-codegen工具,创建了tools.go文件(类似于项目仓库中的示例)。同时创建了internal/handlers/server.go文件:
//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=server.config.yaml ../../openapi.yaml //go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=types.config.yaml ../../openapi.yaml package handlers
server.config.yaml用于配置严格的net/http服务器,types.config.yaml用于生成模型代码。执行go mod init,go mod tidy和go generate ./...后,生成了大部分API启动所需的文件。
编写和测试处理程序
接下来,在server.go中添加以下代码,创建一个实现生成接口的服务器结构:
var _ strictserverinterface = (*server)(nil)
type server struct{}
func newserver() server {
return server{}
}
然后,在user.go中创建POST /users请求的处理程序:
func (*Server) PostUser(ctx context.Context, request PostUserRequestObject) (PostUserResponseObject, error) {
return nil, nil
}
目前返回nil,因为我正在开发user_test.go文件,使用Testify编写测试用例,并定义POST /users的行为。由于数据库尚未连接,响应将是硬编码的结构,以确保测试通过。
后续工作
在接下来的博客文章中,我将继续构建main.go和Dockerfile来启动服务器,并集成Codecov到代码仓库中。 完整的代码可在以下仓库中找到:https://www.php.cn/link/f5f699f14ef1279e76bc576c0459b25a









