如何使用

作为命令行工具

首先在我们的发布页面上下载对应版本二进制文件，然后将二进制文件解压缩到您的 PATH 中的某个位置。

然后，您应该创建一个 yaml 文件来描述您的 API。

以最简单的 学生 API 为例：

database:
  tablename: student
  fields:
    - name: name
      type: varchar(24)
    - name: birthday
      type: date
    - name: school_id
      type: int

将此文件存为 ./student.yaml ，然后运行：

./autoAPI -f ./student.yaml -o ./student

Golang HTTP API代码就会出现在 ./student下，这些代码不过是一个普通的Golang项目，您可以使用 go build 来构建其二进制文件，使用 go run ./main.go 来运行它。 ，或使用您喜欢的任何编辑器来修改它。

请注意，生成的API假定有一个环境变量“ DB_ADDRESS”来指定要连接的数据库地址。

您可以将更多字段添加到配置文件中，并获得不同的API。查看我们的配置文档以获取更多信息。

用作 Github Actions 的一个步骤

由于 autoAPI 也同时作为一个 Docker镜像发布，因此您可以将其直接用作GitHub Actions中的步骤：

- name: Build code
        uses: docker://shureeducation/auto-api:v1.0
        with:
          args: -f ./student.yaml -o ./student

可以参考这个例子。