0

0

构建和部署新 API(第 1 部分)

心靈之曲

心靈之曲

发布时间:2025-01-08 12:30:37

|

630人浏览过

|

来源于php中文网

原创

构建和部署新api (第一部分)

作为一名软件工程师,我热衷于持续学习和技能提升,探索各种软件解决方案。我决定整合以下工具来构建一个新的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 initgo mod tidygo generate ./...后,生成了大部分API启动所需的文件。

Akkio
Akkio

Akkio 是一个无代码 AI 的全包平台,任何人都可以在几分钟内构建和部署AI

下载

编写和测试处理程序

接下来,在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.goDockerfile来启动服务器,并集成Codecov到代码仓库中。 完整的代码可在以下仓库中找到:https://www.php.cn/link/f5f699f14ef1279e76bc576c0459b25a

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

412

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

533

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

309

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

74

2025.09.10

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1023

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

66

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

429

2025.12.29

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1023

2023.10.19

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

65

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Git 教程
Git 教程

共21课时 | 2.8万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.5万人学习

Git中文开发手册
Git中文开发手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号