引入
ts
import { updateIwikiDoc, createIwikiDoc } from 't-comm';
// 不支持 tree-shaking 的项目
import { updateIwikiDoc, createIwikiDoc} from 't-comm/lib/tai/iwiki/index';
// 只支持 ESM 的项目
import { updateIwikiDoc, createIwikiDoc} from 't-comm/es/tai/iwiki/index';updateIwikiDoc()
描述:更新 iwiki 文档内容 使用 POST /v2/doc/save 接口,通过 force: true 强制保存
参数:
示例
ts
await updateIwikiDoc({
prefix: 'https://api.iwiki.woa.com',
id: 12345,
spacekey: 'my-space',
title: '我的文档',
body: '# Hello\n\n更新内容',
contenttype: 'MD',
paasId: 'xxx',
paasToken: 'yyy',
});createIwikiDoc(config)
描述:创建 iWiki 文档 支持创建 Markdown、新文档、文件夹等类型,需要提供 PaaS 认证信息
参数:
| 参数名 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| config | object | 配置信息 | |
| config.prefix | string | API 前缀地址 | |
| [config.spacekey] | string | 空间 key(与 spaceId 二选一) | |
| [config.spaceId] | string | 空间 ID(与 spacekey 二选一) | |
| [config.contenttype] | string | "'MD'" | 内容类型,DOC:新文档,MD:Markdown,FOLDER:文件夹 |
| [config.title] | string | 文档标题 | |
| [config.body] | string | 文档内容 | |
| [config.parentid] | string | number | 父目录 ID | |
| [config.otherData] | object | 其他额外参数 | |
| config.paasId | string | PaaS 认证 ID | |
| config.paasToken | string | PaaS 认证 Token |
返回: Promise.<{code: string, msg: string, data: {id: string, docid: string}, request\_id: string}>
创建结果
示例
ts
const result = await createIwikiDoc({
prefix: 'https://iwiki.woa.com/api',
spacekey: 'my-space',
title: '新文档',
body: '# Hello\n内容',
paasId: 'xxx',
paasToken: 'xxx',
});