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

本文涉及的产品
数据管理 DMS,安全协同 3个实例 3个月
推荐场景:
学生管理系统数据库
数据传输服务 DTS,数据迁移 small 3个月
推荐场景:
MySQL数据库上云
简介: zyplayer-doc是一款现代化的适合团队和个人使用的WIKI文档管理工具,同时还包含数据库文档、Api接口文档

本次升级内容
新增功能

  • 新增API文档编辑功能
  • 空间增加列表展示模式切换
  • 文档搜索支持空格分割后的多关键字搜索
  • 当前空间内支持文件夹的搜索
  • 空间设置的更多里展示创建人信息
  • 空间查看者角色可控制是否允许导出
  • Markdown编辑增加视频和音频的上传快捷按钮
  • 开放文档支持控制顶部标题行和底部链接是否展示
    功能优化
  • 优化Markdown编辑器未开启预览时不再渲染结果
  • 空间uuid仅支持字母和数字限制
  • 优化搜索框和结果的展示
  • 优化富文本编辑页宽度及样式
  • 优化用户总数计算展示问题
  • 优化富文本编辑器上传超时时间和文件大小限制
  • 服务端的外部依赖版本升级,防止已知漏洞
  • 部门列表展示优化,默认全部展开
  • 其他各种细节优化
    问题修复
  • 修复上传文件没有传当前域名问题
  • 修复Excel导入失败问题
    更新详情
    新增API文档编辑功能
    大家期待许久的API文档功能终于和大家见面啦~

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

新建API接口:
image.png

编辑API接口:
image.png

API文档的展示:
image.png

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

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

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

功能配置页:
image.png

文档的搜索:
image.png

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

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

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

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

开放文档支持控制顶部标题行和底部链接是否展示
针对于需要将空间开放文档嵌入至自己的网站或应用中的场景,可开启 隐藏顶部标题 和 隐藏底部版权 功能,隐藏后界面交互的更像一个完整应用。image.png

相关文章
|
5天前
|
分布式计算 API
【通义千问API入门教程】第 2 章 找出网络上两篇文档之间的差异
本章我们将介绍如何利用大模型开发一个文档比对小工具,我们将用这个工具来给互联网上两篇内容相近但版本不同的文档找找茬,并且我们提供了一种批处理文档比对的方案
|
26天前
|
监控 应用服务中间件 API
API 网关的功能用途及实现方式
API 网关的功能用途及实现方式
|
27天前
|
数据可视化 API 开发者
通俗易懂:一步步教你 Flask 项目自动生成 API 文档
Flasgger,作为一款强大的 Flask 扩展,自动从 Flask 应用中提取并生成 OpenAPI 规范文档,配备 SwaggerUI,为开发者提供了一条快捷通道,让 API 的文档编制和交互式测试变得简单易行。Flasgger 的设计原则是简化开发流程,通过与 Flask 框架的无缝整合,让开发者可以更专注于应用逻辑的构建。
|
28天前
|
小程序 安全 API
社区每周丨小程序基础API新增获取设备、系统等多个接口
社区每周丨小程序基础API新增获取设备、系统等多个接口
64 0
|
1月前
|
API
Poi 中文API文档 「40种操作 Excel文件的姿势」
Poi 中文API文档 「40种操作 Excel文件的姿势」
89 0
|
2月前
|
JSON API 数据格式
您可以在钉钉开放平台的API文档中找到对应的API接口来创建审批实例
您可以在钉钉开放平台的API文档中找到对应的API接口来创建审批实例【1月更文挑战第20天】【1月更文挑战第96篇】
23 2
|
1天前
|
数据采集 JavaScript API
第三方系统访问微搭低代码的后端API
第三方系统访问微搭低代码的后端API
|
1天前
|
移动开发 API HTML5
HTML5响应式自动采集API壁纸系统源码自适应手机端
HTML5响应式自动采集API壁纸系统源码自适应手机端
23 11
HTML5响应式自动采集API壁纸系统源码自适应手机端
|
4天前
|
数据挖掘 API 数据处理
获取商品详情信息API接口:1688开放平台功能解析
首先,要获取商品详情信息,开发者需要向1688开放平台申请相应的权限,并遵循其调用规则。在调用商品详情信息API接口时,需要传入相应的请求参数,如商品ID、调用时间戳、密钥等。这些参数对于确保接口的正常运行至关重要。
|
5天前
|
缓存 监控 测试技术
ERP系统对接方案与API接口封装系列(高并发)
企业资源规划(ERP)系统是现代企业管理的核心,它集成了企业内部的各个部门和业务流程。为了实现ERP系统与其他外部系统或应用程序之间的数据交换和协作,需要对接方案。API(应用程序编程接口)是实现系统对接的常用方法之一。

相关产品

  • 数据管理
  • 数据传输服务