Skip to content

引入

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 认证信息

参数

参数名类型默认值描述
configobject配置信息
config.prefixstringAPI 前缀地址
[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.paasIdstringPaaS 认证 ID
config.paasTokenstringPaaS 认证 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',
});