JobOpenApiUsageGuide 任务 API 指南

根据服务账号 Token 和 Scope 动态生成 cURL 调用示例的 API 使用指南。支持配置 Admin 服务地址、切换不同接口示例、一键复制命令。

基本用法

<template>
  <JobOpenApiUsageGuide
    :token="serviceToken"
    :scopes="scopes"
  />
</template>

<script setup>
import { JobOpenApiUsageGuide } from '@/components/job/JobOpenApiUsageGuide.vue'
</script>

Props

属性	类型	默认值	说明
token	String	'${TOKEN}'	服务账号 Token
scopes	Array	—	服务账号的 Scope 列表
compact	Boolean	false	紧凑模式（隐藏错误码说明区域）

功能

• 动态示例生成：根据 token 和 scope 生成 cURL 命令
• 多接口 Tab：切换不同 API 端点示例
• 一键复制：点击复制按钮复制命令到剪贴板
• 错误码说明：展示常见错误码和含义
• 安全提示：Token 保护和最佳实践说明