配置

配置用来告知该程序应该生成什么样的 API。

配置项

支持配置的内容有：

• docker: 生成 Dockerfile 和相关CI文件时的相关信息，不提供这一项则不会生成 Dockerfile
  • username: Docker用户名
  • tag: 要打的tag
• cicd: 生成 CICD 相关配置文件的相关信息，不提供这一项则不会生成相关文件
  • GitHubAction: 是否生成 GitHub Action 配置文件
  • k8s: 是否生成 k8s 配置文件
• database: 数据库相关信息，必填项
  • dbengine: 使用的数据库引擎，不填默认为 pgsql
  • url: 数据库链接url，不提供则无法生成 k8s 配置文件，如果 cicd.k8s 为 true 则会报错
  • tablename: 数据库表名，必填项
  • fields: 数据库中的列，不填会尝试从 url 给出的地址的数据库中拿
    • name: 字段名称
    • type: 字段类型（使用数据库中的类型名称）
  • complex: 复杂查询
    • name: 复杂查询的 API 名称
    • sql: 选取时使用的 sql
    • params: 选取时使用的参数
      • onThis: 在原本table上的外键名称，name与本字段必须给出一个
      • name: 字段名称，onThis与本字段必须给出一个
      • type: 字段类型
    • result: 返回的结果信息
      • array: 是否返回多个结果
      • fields: 数据库中的列
        • name: 字段名称
        • type: 字段类型（使用数据库中的类型名称）

配置来源

系统目标支持以下几种接受配置的方式：

• 命令行参数
• 环境变量
• yaml/toml/json 文件
• .sql 文件
• 数据库元信息
• 默认值

优先级自上而下依次递减，比如：

• 如果你在命令行中提供了 -databaseurl=xxx，则 yaml 中的对应 database.url 会被忽略
• 如果你在输入的 yaml 文件中没有提供 database.fields，则会尝试连接数据库的 database.url 来读取数据库中的元信息来生成 fields 信息。

可以将最终获取到的配置导出到文件。