Documentation
¶
Overview ¶
Package api 实现 toolkit 的 HTTP 接口层代码生成命令。
该包通过交互式采集接口路径、数据表、Web 框架(gin 或 hertz)、接口地址与 软删除策略,读取数据库表结构、索引与主键元数据,按内置或配置文件指定的模板 生成对应的接口处理函数,并在标准输出打印路由注册代码片段。
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( CmdNew = &cobra.Command{ Use: "api", Short: "接口对象", Long: "创建接口对象: toolkit api", Run: Run, } )
CmdNew 是 toolkit api 子命令,交互式采集接口与数据表参数后生成 HTTP 接口代码。
Functions ¶
func Generate ¶
func Generate(moduleParam base.ModuleParam, fullApiDir, tableName, pkg, pkgPath, apiType, apiUrl string)
Generate 按 apiType 选择 hertz 或 gin 模板,渲染 moduleParam 并写入 fullApiDir 下 以表名命名的 Go 文件;同名文件已存在时先删除再创建。
渲染完成后在 fullApiDir 目录执行 go fmt 与 goimports 整理格式,并在标准输出打印 各方法对应的路由注册代码片段。文件创建、模板解析或格式化失败时打印错误并返回, 不向调用方返回错误。apiType 非 hertz 时一律按 gin 模板处理。
func GinTemplate ¶
func GinTemplate() string
GinTemplate 返回 gin 框架的接口代码模板字符串。
配置项 template.Gin 指定了自定义模板文件且文件存在时,读取该文件内容并返回; 否则返回包内置的 gin 模板。模板中使用 {{.Name}} 等占位符,由 Generate 渲染填充。
func HertzTemplate ¶ added in v3.2.31
func HertzTemplate() string
HertzTemplate 返回 hertz 框架的接口代码模板字符串。
配置项 template.Hertz 指定了自定义模板文件且文件存在时,读取该文件内容并返回; 否则返回包内置的 hertz 模板。模板中使用 {{.Name}} 等占位符,由 Generate 渲染填充。
Types ¶
This section is empty.