OpenClaw 开发系列:第9篇-HTTP 路由与 CLI 扩展 — 构建完整基础设施

##服务端 api.registerGatewayMethod("my-plugin:analyze", async (params) => {  const { text, options } = params;  // 执行分析逻辑  const result = await analyzeText(text, options);  return {    score: result.score,    insights: result.insights,    processedAt: new Date().toISOString(),  };});##OpenClaw内部其它方法-客户端// 在另一个插件中（调用方）const result = await gateway.call("my-plugin:analyze", {  text: "Hello world",  options: { language: "en" }});console.log(result.score); // 输出: 0.95 

api.registerCli(  (cli) => {    cli      .command("my-command")      .description("My plugin command description")      .option("--input <file>", "Input file path")      .option("--output <file>", "Output file path")      .option("--verbose", "Verbose output", { default: false })      .action(async (args) => {        const { input, output, verbose } = args;        console.log(`Processing ${input}...`);        const result = await processFile(input);        if (output) {          await writeFile(output, JSON.stringify(result, null, 2));          console.log(`Output written to ${output}`);        } else {          console.log(JSON.stringify(result, null, 2));        }      });  },  {    // 可选配置    name: "my-plugin", // 命令命名空间  });

openclaw my-command --input data.json --output result.json --verbose

api.registerCli(registrar, {  name: "my-plugin",     // 命令命名空间（可选）  hidden: false,         // 是否在帮助中隐藏（默认 false）  description: "My plugin CLI commands", // 分组描述（可选）});

api.registerCli((cli) => {  // 子命令 1：导出数据  cli    .command("export")    .description("Export plugin data")    .option("--format <format>", "Output format (json|csv)", { default: "json" })    .option("--since <date>", "Export data since date")    .action(async (args) => {      const data = await exportData(args.format, args.since);      process.stdout.write(data);    });  // 子命令 2：导入数据  cli    .command("import")    .description("Import data into plugin")    .option("--file <path>", "File to import")    .option("--dry-run", "Preview changes without applying")    .action(async (args) => {      const result = await importData(args.file, args.dryRun);      console.log(`Imported ${result.count} records`);    });  // 子命令 3：状态检查  cli    .command("status")    .description("Check plugin health")    .action(async () => {      const health = await checkHealth();      console.log(`Status: ${health.ok ? "healthy" : "unhealthy"}`);      if (health.details) {        for (const [key, value] of Object.entries(health.details)) {          console.log(`  ${key}: ${value}`);        }      }    });}, { name: "my-plugin" });

api.registerService({  name: "my-sync-service",  description: "Periodically sync data with external source",  async start(context) {    // 启动服务    context.logger.info("Sync service starting");    // 设置定时任务    const interval = setInterval(async () => {      try {        await syncData();        context.logger.debug("Sync completed");      } catch (error) {        context.logger.error("Sync failed", { error: String(error) });      }    }, 60000); // 每分钟同步一次    // 保存引用以便停止时清理    return { interval };  },  async stop(context, state) {    // 停止服务    if (state?.interval) {      clearInterval(state.interval);    }    context.logger.info("Sync service stopped");  },});

api.registerInteractiveHandler({  id: "setup-wizard",  name: "Setup Wizard",  description: "Interactive setup for the plugin",  async handler(context) {    // 步骤 1：询问 API 端点    const endpoint = await context.prompt("Enter API endpoint URL:");    // 步骤 2：询问认证方式    const authMethod = await context.select("Choose auth method:", [      { label: "API Key", value: "api-key" },      { label: "OAuth", value: "oauth" },      { label: "None", value: "none" },    ]);    // 步骤 3：根据选择收集信息    if (authMethod === "api-key") {      const apiKey = await context.prompt("Enter API key:", {        sensitive: true,      });      // 保存配置    }    // 完成    context.success("Setup complete!");  },});

import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";export default definePluginEntry({  id: "monitor-plugin",  name: "Monitor Plugin",  version: "1.0.0",  register(api) {    const metrics: Array<{ timestamp: number; value: number; label: string }> = [];    // HTTP API：获取指标    api.registerHttpRoute({      method: "GET",      path: "/monitor/metrics",      handler: async (_req, res) => {        res.json({          count: metrics.length,          metrics: metrics.slice(-100), // 最近 100 条        });      },    });    // HTTP API：手动上报    api.registerHttpRoute({      method: "POST",      path: "/monitor/report",      handler: async (req, res) => {        const { value, label } = req.body;        metrics.push({          timestamp: Date.now(),          value,          label: label ?? "unnamed",        });        res.json({ recorded: true });      },    });    // 后台服务：定期收集系统指标    api.registerService({      name: "metrics-collector",      async start(context) {        const interval = setInterval(() => {          const memUsage = process.memoryUsage();          metrics.push({            timestamp: Date.now(),            value: memUsage.heapUsed,            label: "heap_used",          });        }, 30000); // 每 30 秒        return { interval };      },      async stop(_context, state) {        if (state?.interval) clearInterval(state.interval);      },    });    // CLI：查看实时指标    api.registerCli((cli) => {      cli        .command("metrics")        .description("View recent metrics")        .option("--last <n>", "Number of entries to show", { default: 10 })        .action(async (args) => {          const entries = metrics.slice(-Number(args.last));          console.log("Timestamp\t\tValue\t\tLabel");          for (const entry of entries) {            const time = new Date(entry.timestamp).toISOString();            console.log(`${time}\t${entry.value}\t${entry.label}`);          }        });      cli        .command("metrics-reset")        .description("Clear all metrics")        .action(async () => {          metrics.length = 0;          console.log("Metrics cleared");        });    }, { name: "monitor" });  },});