CL
文档管理平台

模块文档接入、授权与发布管理

管理员登录

登录后可创建模块、分配 SK、查看下游上传的文档。

返回文档站
CL
文档管理平台 API Doc Center

工作台

文档管理工作台

集中管理模块、SK 授权和下游通过 API 上传的文档。

文档站

平台概览

模块、授权和文档入库状态

暂无写入
模块 0

业务模块

启用 SK 0

可写入密钥

文档 0

已入库

今日变更 0

文档更新

最近文档

按更新时间展示最新入库内容

接入流程

下游项目的标准更新路径

1后台创建模块
2为模块分配 SK 与分类权限
3下游使用 API 上传或更新文档
4平台校验、入库、记录版本

模块列表

模块由后台或接口创建,不在代码里预置。

模块 负责人 状态 创建时间 说明 操作

SK 授权列表

一个 SK 可授权多个模块,并限制可写分类与操作权限。

文档中心

查看下游通过标准 API 上传的文档与当前版本。

文档 模块 分类 类型 版本 状态 更新时间 操作

操作记录

记录后台管理操作、下游 SK 写入文档的动作、IP 与请求信息。

时间 动作 模块 文档 SK IP 请求 ID

下游接入说明

开发同事不需要克隆本仓库,通过 SK 和 API 即可更新文档。

1. 获取 SK

由平台管理员创建模块,并为模块生成 SK。管理员可在 SK 授权列表中重复查看和复制完整 SK。

2. 查看 SK 权限

curl -H "Authorization: Bearer $CL_API_SK" http://127.0.0.1:3100/api/v1/auth/me

3. 上传或更新文档

curl -X PUT http://127.0.0.1:3100/api/v1/docs/takeaway.api.order.create \
  -H "Authorization: Bearer $CL_API_SK" \
  -H "Content-Type: application/json" \
  -d @order-create.json

4. 文档标识规则

文档标识必须以模块标识开头,例如 takeaway.api.order.create。平台会校验分类、内容类型和关键字段。

新增模块

模块标识创建后不可修改。

创建 SK

设置可写模块、文档分类和操作权限。

授权模块
允许分类
操作权限

调整授权模块

选择这个 SK 可以写入的模块。

授权模块

文档详情

文档详情