From bf21056f0476864ca677971bebc396343662c46c Mon Sep 17 00:00:00 2001 From: Mengz <2567587994@qq.com> Date: Sat, 13 Jun 2026 17:40:54 +0800 Subject: [PATCH 1/2] =?UTF-8?q?feat(api):=20=E5=A2=9E=E5=BC=BA=E5=8D=95?= =?UTF-8?q?=E6=AC=A1=E8=B0=83=E7=94=A8=E6=A8=A1=E6=9D=BF=E5=8F=98=E9=87=8F?= =?UTF-8?q?=E4=B8=8E=E9=A2=84=E6=BC=94=E8=83=BD=E5=8A=9B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 14 +++ cmd/api/api.go | 92 +++++++++++++++++-- cmd/api/api_test.go | 99 +++++++++++++++++++++ doc/changes/api-single-request-templates.md | 19 ++++ 4 files changed, 218 insertions(+), 6 deletions(-) create mode 100644 doc/changes/api-single-request-templates.md diff --git a/README.md b/README.md index e5e4318..8fef2bc 100644 --- a/README.md +++ b/README.md @@ -695,6 +695,20 @@ Get-Content issue.json | gitlink-cli api POST /Gitlink/forgeplus/issues --body-s # With query parameters gitlink-cli api GET /Gitlink/forgeplus/commits --query 'page=1&limit=5' + +# Render owner/repo from git context or explicit variables +gitlink-cli api POST /:owner/:repo/issues --body '{"subject":"Bug","description":"..."}' + +# Reuse template variables in a single request +gitlink-cli api POST /v1/{{owner}}/{{repo}}/issues/{{number}}/journals \ + --body '{"notes":"handled by {{actor}}"}' \ + --var owner=Gitlink --var repo=gitlink-cli --var number=42 --var actor=bot + +# Preview a rendered single request without sending it +gitlink-cli api POST /v1/{{owner}}/{{repo}}/issues \ + --body-file issue.json \ + --var owner=Gitlink --var repo=gitlink-cli \ + --dry-run ``` ## Global Parameters diff --git a/cmd/api/api.go b/cmd/api/api.go index cae531a..d225fcb 100644 --- a/cmd/api/api.go +++ b/cmd/api/api.go @@ -7,12 +7,14 @@ import ( "io" "net/url" "os" + "regexp" "strings" "github.com/spf13/cobra" "github.com/gitlink-org/gitlink-cli/cmd/cmdutil" "github.com/gitlink-org/gitlink-cli/internal/client" + repoContext "github.com/gitlink-org/gitlink-cli/internal/context" "github.com/gitlink-org/gitlink-cli/internal/i18n" "github.com/gitlink-org/gitlink-cli/internal/output" ) @@ -73,13 +75,23 @@ func runAPI(c *cobra.Command, args []string) error { path = "/" + path } + vars, err := parseBatchVars(c) + if err != nil { + return err + } + addRepoContextVars(vars) + path, err = renderSinglePath(path, vars) + if err != nil { + return err + } + cli, err := client.New() if err != nil { return err } cli.Debug = cmdutil.Debug - body, err := readJSONBody(c) + body, err := readJSONBody(c, vars) if err != nil { return err } @@ -87,13 +99,24 @@ func runAPI(c *cobra.Command, args []string) error { var query url.Values queryStr, _ := c.Flags().GetString("query") if queryStr != "" { - var err error - query, err = url.ParseQuery(queryStr) + query, err = renderSingleQuery(queryStr, vars) if err != nil { - return fmt.Errorf("invalid query string: %w", err) + return err } } + dryRun, _ := c.Flags().GetBool("dry-run") + if dryRun { + return output.Print(output.SuccessEnvelope(map[string]interface{}{ + "dry_run": true, + "method": method, + "path": path, + "query": query, + "body": body, + "variables": sortedVars(vars), + }, nil), resolveFormat()) + } + env, err := cli.Do(method, path, body, query) if err != nil { var apiErr *client.APIError @@ -107,7 +130,7 @@ func runAPI(c *cobra.Command, args []string) error { return output.Print(env, resolveFormat()) } -func readJSONBody(c *cobra.Command) (interface{}, error) { +func readJSONBody(c *cobra.Command, vars map[string]string) (interface{}, error) { bodyStr, _ := c.Flags().GetString("body") bodyFile, _ := c.Flags().GetString("body-file") bodyStdin, _ := c.Flags().GetBool("body-stdin") @@ -147,7 +170,64 @@ func readJSONBody(c *cobra.Command) (interface{}, error) { if err := json.Unmarshal(data, &body); err != nil { return nil, fmt.Errorf("invalid JSON body: %w", err) } - return body, nil + rendered, err := renderBatchValue(body, vars) + if err != nil { + return nil, fmt.Errorf("render JSON body: %w", err) + } + return rendered, nil +} + +func renderSinglePath(path string, vars map[string]string) (string, error) { + rendered, err := renderTemplate(rewriteColonPlaceholders(path), vars) + if err != nil { + return "", fmt.Errorf("render path: %w", err) + } + return rendered, nil +} + +func renderSingleQuery(raw string, vars map[string]string) (url.Values, error) { + rendered, err := renderTemplate(raw, vars) + if err != nil { + return nil, fmt.Errorf("render query: %w", err) + } + query, err := url.ParseQuery(rendered) + if err != nil { + return nil, fmt.Errorf("invalid query string: %w", err) + } + return query, nil +} + +func addRepoContextVars(vars map[string]string) { + if vars == nil { + return + } + if vars["owner"] != "" && vars["repo"] != "" { + return + } + owner, repo, err := repoContext.ResolveOwnerRepo(cmdutil.Owner, cmdutil.Repo) + if err != nil { + return + } + if vars["owner"] == "" { + vars["owner"] = owner + } + if vars["repo"] == "" { + vars["repo"] = repo + } +} + +func rewriteColonPlaceholders(path string) string { + return colonPathVarPattern.ReplaceAllString(path, `$1{{$2}}`) +} + +var colonPathVarPattern = templatePattern + +func init() { + colonPathVarPattern = mustCompileColonPattern() +} + +func mustCompileColonPattern() *regexp.Regexp { + return regexp.MustCompile(`(^|/):([A-Za-z0-9_.-]+)`) } func resolveFormat() string { diff --git a/cmd/api/api_test.go b/cmd/api/api_test.go index dad41a8..3dca0b7 100644 --- a/cmd/api/api_test.go +++ b/cmd/api/api_test.go @@ -202,6 +202,105 @@ func TestRunAPINoPrefix(t *testing.T) { } } +func TestRunAPIRendersOwnerRepoColonPlaceholders(t *testing.T) { + oldOwner, oldRepo := cmdutil.Owner, cmdutil.Repo + cmdutil.Owner, cmdutil.Repo = "Gitlink", "gitlink-cli" + defer func() { + cmdutil.Owner, cmdutil.Repo = oldOwner, oldRepo + }() + + setupAPITest(t, func(w http.ResponseWriter, r *http.Request) { + if r.URL.Path != "/Gitlink/gitlink-cli/issues.json" { + t.Fatalf("unexpected path: %s", r.URL.Path) + } + json.NewEncoder(w).Encode(map[string]interface{}{"ok": true}) + }) + cmdutil.Format = "json" + + cmd := NewAPICmd() + cmd.SetArgs([]string{"GET", "/:owner/:repo/issues"}) + if err := cmd.Execute(); err != nil { + t.Fatalf("runAPI placeholder error: %v", err) + } +} + +func TestRunAPIRendersVarsInQueryAndBody(t *testing.T) { + var gotBody map[string]interface{} + setupAPITest(t, func(w http.ResponseWriter, r *http.Request) { + if r.URL.Path != "/v1/Gitlink/gitlink-cli/issues/42/journals.json" { + t.Fatalf("unexpected path: %s", r.URL.Path) + } + if r.URL.Query().Get("notify") != "true" { + t.Fatalf("notify query = %q", r.URL.Query().Get("notify")) + } + if err := json.NewDecoder(r.Body).Decode(&gotBody); err != nil { + t.Fatalf("decode body: %v", err) + } + json.NewEncoder(w).Encode(map[string]interface{}{"id": 99}) + }) + cmdutil.Format = "json" + + bodyPath := filepath.Join(t.TempDir(), "body.json") + if err := os.WriteFile(bodyPath, []byte(`{"notes":"hello {{actor}}","meta":{"repo":"{{repo}}"}}`), 0600); err != nil { + t.Fatalf("write body: %v", err) + } + + cmd := NewAPICmd() + cmd.SetArgs([]string{ + "POST", "/v1/{{owner}}/{{repo}}/issues/{{number}}/journals", + "--query", "notify={{notify}}", + "--body-file", bodyPath, + "--var", "owner=Gitlink", + "--var", "repo=gitlink-cli", + "--var", "number=42", + "--var", "notify=true", + "--var", "actor=bot", + }) + if err := cmd.Execute(); err != nil { + t.Fatalf("runAPI rendered vars error: %v", err) + } + if gotBody["notes"] != "hello bot" { + t.Fatalf("notes = %#v", gotBody["notes"]) + } + meta := gotBody["meta"].(map[string]interface{}) + if meta["repo"] != "gitlink-cli" { + t.Fatalf("meta.repo = %#v", meta["repo"]) + } +} + +func TestRunAPIDryRunDoesNotReachServer(t *testing.T) { + setupAPITest(t, func(w http.ResponseWriter, r *http.Request) { + t.Fatal("dry-run should not reach server") + }) + cmdutil.Format = "json" + + cmd := NewAPICmd() + cmd.SetArgs([]string{ + "POST", "/v1/{{owner}}/{{repo}}/issues", + "--body", `{"subject":"{{title}}"}`, + "--dry-run", + "--var", "owner=Gitlink", + "--var", "repo=gitlink-cli", + "--var", "title=Bug report", + }) + if err := cmd.Execute(); err != nil { + t.Fatalf("runAPI dry-run error: %v", err) + } +} + +func TestRunAPIMissingSingleRequestVar(t *testing.T) { + setupAPITest(t, func(w http.ResponseWriter, r *http.Request) { + t.Fatal("should not reach server") + }) + cmdutil.Format = "json" + + cmd := NewAPICmd() + cmd.SetArgs([]string{"GET", "/v1/{{owner}}/{{repo}}/issues/{{number}}"}) + if err := cmd.Execute(); err == nil { + t.Fatal("expected missing variable error") + } +} + func TestRenderBatchRequestsTemplateVars(t *testing.T) { requests, err := renderBatchRequests([]batchRequest{ { diff --git a/doc/changes/api-single-request-templates.md b/doc/changes/api-single-request-templates.md new file mode 100644 index 0000000..6fd98ac --- /dev/null +++ b/doc/changes/api-single-request-templates.md @@ -0,0 +1,19 @@ +# api 单次调用模板变量与预演能力 + +这次改动把 `gitlink-cli api` 的单次调用模式和 batch 模式拉齐了。 + +- 单次调用现在支持 `--var key=value`，可以在路径、查询参数和 JSON 请求体里复用 `{{var}}` 模板变量。 +- 路径里的 `:owner` 和 `:repo` 会自动使用当前 `--owner` / `--repo` 或 git remote 上下文渲染，修复了单次调用不替换占位符的问题。 +- `--dry-run` 不再只属于 batch 模式，单次调用也可以先预览渲染后的 method、path、query、body 和 variables，再决定是否真正发请求。 + +这样做的目的不是单纯补一个 bug，而是让 Raw API 更适合脚本和 Agent 复用：同一份模板写法既能用在 `api --batch-file`，也能平滑退化成一次性的单条请求。 + +本地验证： + +```bash +go test ./cmd/api +go test ./... +go build ./... +git diff --check +go run . api --help +``` From 98b3460db4c116b1f22b3df7a86aed14aadd874f Mon Sep 17 00:00:00 2001 From: Mengz <2567587994@qq.com> Date: Wed, 24 Jun 2026 17:19:36 +0800 Subject: [PATCH 2/2] =?UTF-8?q?docs(api):=20=E8=A1=A5=E9=BD=90=E5=8D=95?= =?UTF-8?q?=E6=AC=A1=E6=A8=A1=E6=9D=BF=E8=B0=83=E7=94=A8=E5=B8=AE=E5=8A=A9?= =?UTF-8?q?=E4=B8=8E=E4=B8=AD=E6=96=87=E7=A4=BA=E4=BE=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.zh-CN.md | 14 ++++++++++++++ cmd/api/api.go | 2 ++ internal/i18n/locales/en-US.json | 4 ++-- internal/i18n/locales/zh-CN.json | 4 ++-- 4 files changed, 20 insertions(+), 4 deletions(-) diff --git a/README.zh-CN.md b/README.zh-CN.md index 6a8879d..b7460a0 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -569,6 +569,20 @@ Get-Content issue.json | gitlink-cli api POST /Gitlink/forgeplus/issues --body-s # 带查询参数 gitlink-cli api GET /Gitlink/forgeplus/commits --query 'page=1&limit=5' + +# 从 git 上下文或显式 owner/repo 渲染路径占位符 +gitlink-cli api POST /:owner/:repo/issues --body '{"subject":"Bug","description":"..."}' + +# 在单次请求中复用模板变量 +gitlink-cli api POST /v1/{{owner}}/{{repo}}/issues/{{number}}/journals \ + --body '{"notes":"handled by {{actor}}"}' \ + --var owner=Gitlink --var repo=gitlink-cli --var number=42 --var actor=bot + +# 先预览渲染后的单次请求，再决定是否真正发送 +gitlink-cli api POST /v1/{{owner}}/{{repo}}/issues \ + --body-file issue.json \ + --var owner=Gitlink --var repo=gitlink-cli \ + --dry-run ``` ## 全局参数 diff --git a/cmd/api/api.go b/cmd/api/api.go index d225fcb..ca9460c 100644 --- a/cmd/api/api.go +++ b/cmd/api/api.go @@ -32,6 +32,8 @@ func NewAPICmd(translators ...*i18n.Translator) *cobra.Command { gitlink-cli api GET /projects --query 'page=1&limit=10' gitlink-cli api POST /:owner/:repo/issues --body '{"subject":"Bug","description":"..."}' gitlink-cli api POST /:owner/:repo/issues --body-file issue.json + gitlink-cli api POST /v1/{{owner}}/{{repo}}/issues/{{number}}/journals --body '{"notes":"handled by {{actor}}"}' --var owner=Gitlink --var repo=gitlink-cli --var number=42 --var actor=bot + gitlink-cli api POST /v1/{{owner}}/{{repo}}/issues --body-file issue.json --var owner=Gitlink --var repo=gitlink-cli --dry-run gitlink-cli api --batch-file plan.json --dry-run gitlink-cli api --batch-file plan.json --var owner=Gitlink --var repo=gitlink-cli`, Args: validateAPIArgs, diff --git a/internal/i18n/locales/en-US.json b/internal/i18n/locales/en-US.json index 0739395..52b8aca 100644 --- a/internal/i18n/locales/en-US.json +++ b/internal/i18n/locales/en-US.json @@ -115,9 +115,9 @@ "error.profile.user_required": "could not determine target user; pass --user or run gitlink-cli auth login", "error.unsupported_language": "unsupported language: {lang}", "flag.api.batch_continue_on_error": "Continue running remaining batch requests after a failure", - "flag.api.batch_dry_run": "Preview batch requests without sending remote requests", + "flag.api.batch_dry_run": "Preview rendered request(s) without sending remote requests", "flag.api.batch_file": "Read an API batch plan from a JSON file", - "flag.api.batch_var": "Override a batch template variable (key=value, repeatable)", + "flag.api.batch_var": "Provide a template variable override (key=value, repeatable)", "flag.api.body": "Request body (JSON string)", "flag.api.body_file": "Read request body JSON from a file", "flag.api.body_stdin": "Read request body JSON from stdin", diff --git a/internal/i18n/locales/zh-CN.json b/internal/i18n/locales/zh-CN.json index 2e6fc4d..15e6829 100644 --- a/internal/i18n/locales/zh-CN.json +++ b/internal/i18n/locales/zh-CN.json @@ -115,9 +115,9 @@ "error.profile.user_required": "无法确定目标用户；请通过 --user 指定，或先运行 gitlink-cli auth login 登录", "error.unsupported_language": "不支持的语言：{lang}", "flag.api.batch_continue_on_error": "批处理请求失败后继续执行后续请求", - "flag.api.batch_dry_run": "预览批处理请求，不发送远端请求", + "flag.api.batch_dry_run": "预览渲染后的请求，不发送远端请求", "flag.api.batch_file": "从 JSON 文件读取 API 批处理计划", - "flag.api.batch_var": "覆盖批处理模板变量（key=value，可重复）", + "flag.api.batch_var": "提供模板变量覆盖值（key=value，可重复）", "flag.api.body": "请求体（JSON 字符串）", "flag.api.body_file": "从文件读取 JSON 请求体", "flag.api.body_stdin": "从标准输入读取 JSON 请求体",