showdoc

今天给各位分享showdoc下载 showdoc（v1.33.2）官方版的知识，其中也会对小编亲测优质的APP进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

软件简介

软件功能

API 文档：

APP、Web前端和服务器常用API进行交互

ShowDoc可以非常方便快捷地编写漂亮的API文档

数据字典：

一个好的数据字典可以很容易地向其他人描述你的数据库结构

使用ShowDoc编辑漂亮的数据字典

文档：

您可以使用ShowDoc来编写一些工具的说明

还可以写一些技术规范文档供团队审核。

团队合作：

团队权限管理机制让团队在撰写文档时能够很好地协作

文档自动化：

可以根据代码注释自动生成文档

配备RunApi客户端、可调试接口和自动生成文档

免费和开源：

ShowDoc 提供免费开源版本

您可以选择将ShowDoc部署到您的服务器

在线托管：

www.showdoc.com.cn 安全稳定的在线文档托管服务

您可以安全地选择将文档数据托管在云中

软件特色

1. ShowDoc上有两种类型的项目：公共项目和私人项目。

2. 任何登录或未登录的用户都可以访问公共项目。

3. 私有项目需要密码验证访问，密码由项目创建者设置。

4. 您可以轻松地向ShowDoc 项目添加和删除项目成员。

5. 项目成员可以编辑项目，但不能转移或删除项目。

6.点击编辑器上方按钮，轻松插入API接口模板和数据字典模板。

7.插入模板后，剩下的就是修改数据了，这样可以节省大量的编辑工作。

8、项目创建者可以自由地将项目转让给网站的其他用户。

9. 通过使用showdoc的团队功能，您可以更好地进行团队协作。

常见问题

1、忘记密码怎么办？

如果您使用的是在线ShowDoc（http://www.showdoc.com.cn），如果您忘记密码，可以联系xing7th@gmail.com，并在邮件中注明您的用户名和项目名称（至少提供两个项目）。

如果您自己部署了ShowDoc，请先根据之前的安装文档进行升级，以确保您使用的是最新的代码（重点是添加的）。然后，根据您的安装方式，有不同的密码重置方法。

如果使用官方脚本或者docker方式安装，请在命令行执行命令：

docker exec showdoc bash -c 'cd /var/www/html/php ./index.php home/common/repasswd'

如果手动安装PHP，则在命令行切换到showdoc安装目录，执行：

php index.php home/common/repasswd

上述命令会将管理员showdoc密码重置为123456。使用该密码登录管理后端，可以管理普通用户和项目。建议登录后更改密码。

如果您更改密码时出错，请确保您使用的是最新版本的代码。

2、showdoc私有版如何连接数据库

showdoc 使用sqlite 数据库。数据库文件是安装目录中的Sqlite/showdoc.db.php。你可以在网上搜索如何在命令行中使用sqlite数据库。或者使用SQLiteStudio等可视化工具

3. 我可以创建和编辑文档，但上传或下载附件时出现问题。

一般是由于绑定域名时没有按照官网教程操作导致的。

4. 错误消息“General error: 11 数据库磁盘映像格式错误”

请确保服务器上安装了php环境和php-sqlite扩展；

如果您通过FTP上传代码到服务器，请使用二进制模式上传，否则会损坏数据库文件并导致此错误消息。

5. 可以使用mysql数据库吗？

MySQL 数据库不再受到官方支持。详情请参见：点此跳转。如果你确实需要强制使用MySQL，你可以自己开发，但官方不提供支持，所以请不要浪费时间询问官方团队。进行过二次开发的版本可能会与未来正式版本升级冲突，导致升级失败。请仔细考虑。

6. 验证码不显示

请检查php-gd库是否安装

7、提示验证码验证失败。

首先检查php-sqlite3扩展是否安装。

如果不行的话，去php.ini文件中找到session保存的目录，然后检查session安装的目录是否有写权限，或者磁盘空间是否已满。如果已经绑定了域名，可以参考官方教程进行绑定。

八、如何进入管理后台

版本更新说明

v3.2.5 和v3.2.6

修复了一些安全问题

v3.2.3

定期更新以修复一些已知错误

版本v3.2.0、v3.2.1 和v3.2.2

该版本主要优化视觉UI和交互体验。

多个文档目录支持拖动排序和右键菜单操作，可快速添加页面和子文件。

优化移动接入项目效果

将产品图标替换为更好看的图标

优化小屏设备访问效果

将大部分与页面相关的操作移至文档目录树底部的操作栏

其他小细节

版本v3.1.0

新增AI助手功能，辅助文档生成。 Showdoc在官网默认是开启的，私有版的showdoc需要管理员在后台开启。

版本v3.0.0、v3.0.1 和v3.0.3

UI和交互逻辑进行了重写，大大提升了视觉效果和操作体验，包括但不限于以下内容：

多个项目展示时采用列表结构，完善项目分组功能，适应更多项目场景。

大多数打开新页面的操作，如用户中心、目录管理、团队管理等，都改为当前页面弹窗形式，关闭弹窗后更方便返回之前的操作向上窗口并避免碎片感。

完善拖拽组件，涉及拖拽场景，如项目分组的拖拽、页面排序的拖拽、目录管理的拖拽，统一元素高度和风格。

调整项目展示页面的布局，包括常规多页项目、单页项目和表格展示项目，并添加统一的页眉和图标样式。

调整功能按钮的显示和收起逻辑，在方便和简洁之间取得平衡。

修复一些累积的bug

版本v2.10.10

修复累积的错误和UI 兼容性问题

版本v2.10.8

紧急修复v2.10.7引起的bug

版本v2.10.7

修复sh脚本自动生成runapi接口的问题

修复从vscode 粘贴代码的问题

runapi项目可以在showdoc上导出（word格式）

优化代码结构

版本v2.10.6

项目展示页面可一键展开或折叠所有目录

优化导出markdown压缩包功能

优化docker升级机制

优化json转参数表功能

优化附件下载功能

版本v2.10.5

修复导入文件时内存不足的bug

在代码块中使用固定宽度字体

团队成员也增加团队展示

添加成员时，可以快速选择之前的成员

版本v2.10.4

更改代码块样式

修复文件上传漏洞

修复编辑器中转义部分特殊字符的bug

添加了用于将SQL 转换为Markdown 表的格式化工具

允许设置退出OAuth2 时的回调

版本v2.10.3

优化openapi文件导入

LDAP 设置优化

解决重复弹出消息的问题

修复验证码机制bug

默认情况下，引用的文本将直接呈现

版本v2.10.2

添加团队成员时，您可以将成员设置为团队管理员，以允许多人管理团队。

添加项目成员时，可以将成员设置为项目管理员，实现多人管理项目。

新增模板分享功能。模板可以与项目成员共享以供使用。

注释脚本可以生成runapi项目，并可以在runapi客户端上调试

浏览器新消息提醒

版本v2.10.1

该版本是v2.10.0的修复版本，专门修复v2.10.0中意外引入的bug

版本v2.10.0

安全更新

新增页面修改提醒功能，通知指定项目成员

增加项目变更记录功能

您可以将该文件（postman/swagger/markdown压缩包）导入到现有项目中，也可以重复导入覆盖更新。

优化评论生成文档功能

支持通过s3协议上传附件

版本v2.9.15

安全更新

修复swagger文件导入问题

修复点击文件库错误的问题

支持runapi客户端错误返回示例

支持runapi客户端的搜索功能

支持runapi客户端的查询和路径变量功能

版本v2.9.14

可一键将团队成员的项目权限设置为只读

选择目录时，可以输入关键字搜索该目录

编辑页面时可以跳转创建新目录。

改进页面排序功能

修复xss安全漏洞

解决TOC目录遮挡图标的问题

支持runapi客户端的界面状态功能

支持runapi客户端全局cookies功能

支持runapi客户端全局脚本功能

OK，本文到此结束，希望对大家有所帮助。