前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >一款支持API文档编辑功能的WIKI文档管理系统

一款支持API文档编辑功能的WIKI文档管理系统

原创
作者头像
用户3880245
发布2023-11-06 16:33:55
3000
发布2023-11-06 16:33:55
举报
文章被收录于专栏:zyplayer-doczyplayer-doc

本次升级内容

新增功能

  • 新增API文档编辑功能
  • 空间增加列表展示模式切换
  • 文档搜索支持空格分割后的多关键字搜索
  • 当前空间内支持文件夹的搜索
  • 空间设置的更多里展示创建人信息
  • 空间查看者角色可控制是否允许导出
  • Markdown编辑增加视频和音频的上传快捷按钮
  • 开放文档支持控制顶部标题行和底部链接是否展示

功能优化

  • 优化Markdown编辑器未开启预览时不再渲染结果
  • 空间uuid仅支持字母和数字限制
  • 优化搜索框和结果的展示
  • 优化富文本编辑页宽度及样式
  • 优化用户总数计算展示问题
  • 优化富文本编辑器上传超时时间和文件大小限制
  • 服务端的外部依赖版本升级,防止已知漏洞
  • 部门列表展示优化,默认全部展开
  • 其他各种细节优化

问题修复

  • 修复上传文件没有传当前域名问题
  • 修复Excel导入失败问题

更新详情

新增API文档编辑功能

大家期待许久的API文档功能终于和大家见面啦~

在文档列表的 加号 展开菜单中即可看到 新建API接口 按钮,创建后将以大家熟悉的API编写界面来编辑API文档,具有统一的编辑和查看风格,不必再花费许久时间来调整API文档的展示格式。

新建API接口:

编辑API接口:

API文档的展示:

空间增加列表展示模式切换

卡片模式便于空间的查看,而列表模式更注重空间的管理和搜索编辑,您可以在两种模式之间随意来回切换。

文档搜索支持空格分割后的多关键字搜索

以前文档搜索时只能单个关键字的模糊匹配,无法做到多关键字的模糊搜索,此次我们支持了通过空格分割的多关键字模糊匹配,并按匹配度排序返回结果。

此功能需要在首页的系统配置页内手动开启,由于匹配内容变多,理论上搜索效率可能会降低,对数据库的压力会增大一些,有需求的用户可开启使用。

功能配置页:

文档的搜索:

当前空间内支持文件夹的搜索

空间设置的更多里展示创建人信息

空间查看者角色可控制是否允许导出

Markdown编辑增加视频和音频的上传快捷按钮

开放文档支持控制顶部标题行和底部链接是否展示

针对于需要将空间开放文档嵌入至自己的网站或应用中的场景,可开启 隐藏顶部标题隐藏底部版权 功能,隐藏后界面交互的更像一个完整应用。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 新增功能
  • 功能优化
  • 问题修复
  • 更新详情
    • 新增API文档编辑功能
      • 空间增加列表展示模式切换
        • 文档搜索支持空格分割后的多关键字搜索
          • 当前空间内支持文件夹的搜索
            • 空间设置的更多里展示创建人信息
              • 空间查看者角色可控制是否允许导出
                • Markdown编辑增加视频和音频的上传快捷按钮
                  • 开放文档支持控制顶部标题行和底部链接是否展示
                  相关产品与服务
                  文档服务
                  文档服务(Document Service,DS)是腾讯云数据万象提供云上文档处理服务,支持多种类型的文件生成图片或 html 格式的预览,可以解决文档内容的页面展示问题,满足 PC、App 等多端的文档在线浏览需求。同时,本产品还提供文本隐私筛查能力,可以有效识别文本中的身份证号、银行卡号、手机号等敏感数据,满足数据可用性和隐私保护的各种要求。
                  领券
                  问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档