开发文档插件开发

CI 自动发版

用发布令牌在脚本或 CI 里上传插件新版本,和在网页上传走同一套校验和审核。

准备

  1. 先在「我的作品」建好插件(key 建后不能改),上传接口不会自动建档。
  2. 在「发布新版本」页底部新建「CI 发布令牌」,可以限定只能发布某一个插件,并设置有效期。
  3. 令牌只显示一次,存进 CI 的密钥配置,例如 DEEPDOER_PUBLISH_TOKEN。

发布令牌只能上传版本和查询审核状态,不能调用模型、改价或提现。泄露后请立即在同一位置撤销。

上传版本

Shell
curl -X POST "https://deepdoer.cn/developers/v1/plugins/my-plugin/versions" \
  -H "Authorization: Bearer $DEEPDOER_PUBLISH_TOKEN" \
  -F file=@my-plugin.zip \
  -F changelog="修复了导出格式"

成功返回 201,内容是这个版本的信息,status 为 pending(待审核):

JSON
{
  "id": 1024,
  "key": "my-plugin",
  "version": "1.2.0",
  "status": "pending",
  "sha256": "…",
  "sizeBytes": 18342,
  "permissions": ["clipboard.write"]
}
  • zip 根目录直接是 manifest.json,最大 32MB。
  • version 必须高于已通过的最高版本;被驳回的版本可以用同一版本号重新上传。
  • 每个令牌每小时最多上传 30 次。

查询审核状态

Shell
curl "https://deepdoer.cn/developers/v1/plugins/my-plugin/versions" \
  -H "Authorization: Bearer $DEEPDOER_PUBLISH_TOKEN"

返回最近 50 个版本(新的在前)。status 取值:pending 待审核、approved 已上架、rejected 已驳回(看 reviewComment)、obsolete 已被新版本替代。

GitHub Actions 示例

YAML
name: publish-plugin
on:
  push:
    tags: ['v*']
jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Pack
        run: cd my-plugin && zip -r ../my-plugin.zip . -x '.*'
      - name: Upload
        run: |
          curl --fail-with-body -X POST \
            "https://deepdoer.cn/developers/v1/plugins/my-plugin/versions" \
            -H "Authorization: Bearer ${{ secrets.DEEPDOER_PUBLISH_TOKEN }}" \
            -F file=@my-plugin.zip \
            -F changelog="${GITHUB_REF_NAME}"

错误

错误格式和 Model API 一样:{"error": {"message": "…", "type": "…", "param": null, "code": "…"}},按 code 判断即可。

HTTP code 原因
401 invalid_token 令牌缺失、写错、已撤销或已过期
403 forbidden 令牌限定了别的插件
400 invalid_request 插件 key 不合法,或没有用 multipart/form-data 上传 file
400 rejected 包不合格、版本号不够新、插件不存在等,message 里有具体原因
413 payload_too_large 包超过 32MB
429 rate_limited 上传太频繁:每个令牌每小时最多 30 次
500 server_error 服务暂时不可用,稍后重试