feat(api): 增强单次调用模板变量与预演能力
This commit is contained in:
parent
71ca2bb683
commit
bf21056f04
14
README.md
14
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
|
||||
|
|
|
|||
|
|
@ -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 {
|
||||
|
|
|
|||
|
|
@ -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{
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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
|
||||
```
|
||||
Loading…
Reference in New Issue