AgentSkillsCN

debug-backend-api

使用请求CLI工具调试并测试后端API端点。当用户希望测试API端点、调试后端处理器、检查API响应，或调查服务器端问题时，可调用此功能。

SKILL.md
--- frontmatter
name: debug-backend-api
description: Debug and test backend API endpoints using the request CLI tool. Use when the user wants to test an API endpoint, debug a backend handler, check API responses, or investigate server-side issues.

Debug Backend API

Quick Start

Use go run ./script/request to send authenticated HTTP requests to the local server (port 23712).

bash
# GET request
go run ./script/request /api/checkpoints?project=myproject

# POST request with JSON body
go run ./script/request /api/checkpoints '{"project_dir":"/path/to/project","name":"test","file_paths":["file.txt"]}'

The tool automatically reads .ai-critic/server-credentials for auth (cookie: ai-critic-token).

Usage

code
go run ./script/request <path> [body]
  • •No body → GET request
  • •With body → POST request with Content-Type: application/json
  • •Status line printed to stderr, response body to stdout
  • •Pipe to jq for formatted output: go run ./script/request /api/xxx | jq .

Common Endpoints

EndpointMethodDescription
/api/auth/checkGETVerify auth is working
/api/checkpoints?project=NAMEGETList checkpoints
/api/checkpoints?project=NAMEPOSTCreate checkpoint
/api/checkpoints/ID?project=NAMEGETGet checkpoint detail
/api/checkpoints/current-changes?project=NAME&project_dir=DIRGETGet current changes
/api/checkpoints/diff?project=NAME&project_dir=DIRGETGet current diffs
/api/files?dir=DIRGETList files in directory
/api/files/content?dir=DIR&path=FILEGETRead file content
/api/port-forwardsGETList port forwards
/api/agentsGETList agents
/api/terminal/sessionsGETList terminal sessions

Debugging Workflow

  1. •Identify the endpoint: Check the frontend API call in ai-critic-react/src/api/ to find the endpoint path and parameters.
  2. •Send a test request: Use go run ./script/request with the endpoint.
  3. •Inspect the response: Check status code and response body.
  4. •Find the handler: Backend handlers are registered in server/server.go (main routes) or in sub-packages like server/checkpoint/, server/portforward/, server/terminal/.
  5. •Add debug logging: Add fmt.Printf("DEBUG ...") lines in the handler, rebuild with go run ./script/server/run, and re-test.

Important Notes

  • •Server must be running (go run ./script/server/run) before sending requests.
  • •The .ai-critic/server-credentials file must exist if auth is enabled; each line is a valid token.
  • •Always limit output when piping: go run ./script/request /api/xxx | head -c 4096.