代码补全 API

本文档描述了 Trae 代码补全功能的 API 接口。

概述

代码补全 API 提供智能代码建议和自动补全功能，帮助开发者提高编码效率。

端点

获取代码补全建议

POST /api/code-completion/suggest

请求参数

参数	类型	必需	描述
code	string	是	当前代码内容
cursor_position	number	是	光标位置
language	string	是	编程语言
context	object	否	上下文信息

响应

{
  "suggestions": [
    {
      "text": "console.log",
      "type": "function",
      "description": "输出日志到控制台",
      "score": 0.95
    },
    {
      "text": "const",
      "type": "keyword",
      "description": "声明常量",
      "score": 0.85
    }
  ],
  "cursor_offset": 0
}

获取函数签名

POST /api/code-completion/signature

请求参数

参数	类型	必需	描述
function_name	string	是	函数名称
language	string	是	编程语言
context	object	否	上下文信息

响应

{
  "signature": "function myFunction(param1: string, param2: number): boolean",
  "parameters": [
    {
      "name": "param1",
      "type": "string",
      "description": "第一个参数"
    },
    {
      "name": "param2",
      "type": "number",
      "description": "第二个参数"
    }
  ],
  "return_type": "boolean",
  "description": "函数描述"
}

补全类型

• keyword - 关键字
• function - 函数
• variable - 变量
• class - 类
• method - 方法
• property - 属性
• snippet - 代码片段

示例

获取代码补全

const response = await fetch('/api/code-completion/suggest', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    code: 'const message = "Hello"; cons',
    cursor_position: 26,
    language: 'javascript',
    context: {
      file_path: '/src/app.js',
      project_type: 'node'
    }
  })
});

const suggestions = await response.json();
console.log('补全建议:', suggestions.suggestions);

获取函数签名帮助

const response = await fetch('/api/code-completion/signature', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    function_name: 'fetch',
    language: 'javascript'
  })
});

const signature = await response.json();
console.log('函数签名:', signature.signature);