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

本文涉及的产品
数据传输服务 DTS,数据同步 small 3个月
推荐场景:
数据库上云
数据管理 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

相关文章
|
1月前
|
Java API 数据库
构建RESTful API已经成为现代Web开发的标准做法之一。Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐。
【10月更文挑战第11天】本文介绍如何使用Spring Boot构建在线图书管理系统的RESTful API。通过创建Spring Boot项目,定义`Book`实体类、`BookRepository`接口和`BookService`服务类,最后实现`BookController`控制器来处理HTTP请求,展示了从基础环境搭建到API测试的完整过程。
42 4
|
1月前
|
API
阿里云短信服务文档与实际API不符
阿里云短信服务文档与实际API不符
|
3月前
|
JSON API 数据处理
Winform管理系统新飞跃:无缝集成SqlSugar与Web API,实现数据云端同步的革新之路!
【8月更文挑战第3天】在企业应用开发中,常需将Winform桌面应用扩展至支持Web API调用,实现数据云端同步。本文通过实例展示如何在已有SqlSugar为基础的Winform系统中集成HTTP客户端调用Web API。采用.NET的`HttpClient`处理请求,支持异步操作。示例包括创建HTTP辅助类封装请求逻辑及在Winform界面调用API更新UI。此外,还讨论了跨域与安全性的处理策略。这种方法提高了系统的灵活性与扩展性,便于未来的技术演进。
246 2
|
3月前
|
开发框架 缓存 前端开发
基于SqlSugar的开发框架循序渐进介绍(23)-- Winform端管理系统中平滑增加对Web API对接的需求
基于SqlSugar的开发框架循序渐进介绍(23)-- Winform端管理系统中平滑增加对Web API对接的需求
|
7天前
|
JSON 前端开发 API
后端开发中的API设计与文档编写指南####
本文探讨了后端开发中API设计的重要性,并详细阐述了如何编写高效、可维护的API接口。通过实际案例分析,文章强调了清晰的API设计对于前后端分离项目的关键作用,以及良好的文档习惯如何促进团队协作和提升开发效率。 ####
|
7天前
|
存储 前端开发 搜索推荐
淘宝 1688 API 接口助力构建高效淘宝代购集运系统
在全球化商业背景下,淘宝代购集运业务蓬勃发展,满足了海外消费者对中国商品的需求。掌握淘宝1688 API接口是构建成功代购系统的關鍵。本文详细介绍如何利用API接口进行系统架构设计、商品数据同步、订单处理与物流集成,以及用户管理和客户服务,帮助你打造一个高效便捷的代购集运系统,实现商业价值与用户满意度的双赢。
|
22天前
|
监控 安全 测试技术
我们为什么要API管理系统呢?
API 管理系统通过接口标准化与复用、简化开发流程、版本管理、监控与预警、访问控制、数据加密、安全审计、集中管理与共享、协作开发、快速对接外部系统和数据驱动的决策等多方面优势,显著提高开发效率、增强系统可维护性、提升系统安全性、促进团队协作与沟通,并支持业务创新与扩展。
|
1月前
|
机器学习/深度学习 算法 Java
通过 Java Vector API 利用 SIMD 的强大功能
通过 Java Vector API 利用 SIMD 的强大功能
42 10
|
1月前
|
移动开发 前端开发 JavaScript
前端开发实战:利用Web Speech API之speechSynthesis实现文字转语音功能
前端开发实战:利用Web Speech API之speechSynthesis实现文字转语音功能
155 0
|
1月前
|
供应链 搜索推荐 数据挖掘
电商ERP系统中电商API接口的应用
电商API接口在电子商务中扮演着至关重要的角色,它们允许开发者将电商功能集成到自己的应用程序中,实现商品检索、订单处理、支付、物流跟踪等功能。以下是关于电商API接口的应用: