API 参考
VibeCLI API 文档
完整的VibeCLI 2.0 API参考文档，包含四大核心工具接口、认证方式、请求响应格式和代码示例
快速开始
几步完成VibeCLI API集成
认证方式
VibeCLI支持OAuth 2.1和API密钥两种认证方式
OAuth 2.1
标准OAuth 2.1认证流程
// 获取访问令牌
const response = await fetch('/api/auth/token', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
grant_type: 'client_credentials',
client_id: 'your_client_id',
client_secret: 'your_client_secret',
scope: 'mcp:tools mcp:resources'
})
});
const { access_token } = await response.json();API Key
简单的API密钥认证
// 使用API密钥
const response = await fetch('/mcp/tools/project_analyzer', {
method: 'POST',
headers: {
'Authorization': 'Bearer your_api_key',
'Content-Type': 'application/json',
},
body: JSON.stringify(requestData)
});核心工具API
四大核心工具的详细API接口文档
POST/mcp/tools/project_analyzer
分析用户需求，推荐技术栈和架构
项目分析器
请求参数
{
"requirement": "string",
"preferences": {
"framework": "string?",
"database": "string?",
"deployment": "string?"
},
"constraints": {
"timeline": "string?",
"budget": "number?",
"team_size": "number?"
}
}POST/mcp/tools/template_generator
基于分析结果生成完整项目模板
模板生成器
请求参数
{
"analysis_result": "object",
"project_name": "string",
"custom_requirements": "string?"
}POST/mcp/tools/feature_composer
动态添加和组合复杂功能模块
功能合成器
请求参数
{
"project_path": "string",
"feature_description": "string",
"integration_mode": "string"
}POST/mcp/tools/deployment_manager
智能部署配置和多平台发布
部署管理器
请求参数
{
"project_path": "string",
"target_platform": "string",
"environment": "string",
"deployment_config": "object"
}SDK示例
多种编程语言的SDK使用示例
JavaScript SDK
import { VibeCLI } from '@vibecli/sdk';
const client = new VibeCLI({
apiKey: 'your_api_key',
baseURL: 'https://api.vibecli.com'
});
// 分析项目需求
const analysis = await client.tools.projectAnalyzer({
requirement: '创建一个博客系统',
preferences: {
framework: 'Next.js'
}
});
// 生成项目模板
const template = await client.tools.templateGenerator({
analysisResult: analysis,
projectName: 'my-blog'
});
console.log('项目创建完成:', template.projectStructure);错误代码
API可能返回的错误代码和处理建议
400
Bad Request
请求参数错误或缺失必要字段
401
Unauthorized
API密钥无效或已过期
403
Forbidden
没有权限访问该资源
404
Not Found
请求的资源不存在
429
Too Many Requests
请求频率超过限制
500
Internal Server Error
服务器内部错误