showdoc官方下载(api文档编辑工具)

showdoc手机版是一款在线api文档编辑工具，对于一些程序员来说这款软件还是挺实用的，这是一款非常适合IT团队的在线API文档、技术文档工具，有需要的朋友来这里下载吧！

软件简介

ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc，你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档，你还可以利用showdoc的自动化能力，从程序注释中自动生成API文档，或者从搭配的RunApi客户端（类似postman的api调试工具）中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员，你可以很方便地进行项目文档的权限管理和团队协作，也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端，有win客户端、mac客户端、ios、android等，更方便跨平台使用。目前超过100000+的互联网团队正在使用showdoc，包括知名公司内部的一些团队，比如腾讯、华为、百度、京东、字节跳动、顺丰等等。

软件功能

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 database disk image is malformed”

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

如果你以FTP方式上传代码到服务器，那么请使用二进制模式上传，否则会损害数据库文件，导致此错误提示

5，可以使用mysql数据库吗

官方已经不再支持mysql数据库，详情可看：点此跳转 。如你真的需要强制使用mysql，则可自行二次开发，但官方不提供支持，也请勿浪费时间问官方团队。经过二次开发的版本有可能与官方以后的版本升级冲突导致升级失败，请谨慎考虑

6，验证码不显示

请检查是否安装了php-gd库

7，提示验证码验证失败

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

如果不行，则到php.ini文件下找找session的保存目录，然后检查安装session目录有没有写入权限，或者可不可能是磁盘空间满了的问题。如果是有绑定了域名，可以参考官方的教程来绑定。

8，怎么进入管理后台

新安装完成后，默认管理员账号是showdoc/123456 。使用管理员帐户登录后，在项目列表页面的右上角便能看到管理后台入口。如果不能，请重新登录或者刷新浏览器缓存试试

版本更新说明

v3.2.5 和 v3.2.6

修复了一些安全问题

v3.2.3

常规更新，修复一些已知的bug

版本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和交互逻辑，大大提升了视觉效果和操作体验，包括但不限于以下内容：

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

大部分打开新页面的操作，如用户中心、目录管理、团队管理等等，都改为当前页面弹窗的形式，方便关闭弹窗后无感回到之前的操作，避免割裂感。

完善拖放组件，涉及到拖放的场景，比如项目分组的拖放、页面排序的拖放、目录管理的拖放，都统一元素高度和样式。

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

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

修复一些累积的bug

版本v2.10.10

修复累积的bug以及UI兼容问题

版本v2.10.8

紧急修复由v2.10.7引起的bug

版本v2.10.7

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

修复从vscode粘贴代码的问题

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

优化代码的结构

版本v2.10.6

项目展示页面可一键展开或者折叠全部目录

优化导出markdown压缩包功能

优化docker升级机制

优化json转参数表格的功能

优化附件下载功能

版本v2.10.5

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

在代码块中使用等宽字体

解决火狐浏览器下复制粘贴的兼容问题

团队成员也增加团队显示

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

版本v2.10.4

可以快速复制网页文章到showdoc，会自动转成markdown格式

更改代码块样式

代码块增加快速复制功能

修复文件上传漏洞

修复编辑器一些特殊字符转义的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存在bug，会导致无法复制目录以及手动安装showdoc时可能出问题

版本v2.10.0

安全更新

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

增加项目变更记录功能

可以导入文件(postman/swagger/markdown压缩包)到已存在的项目内，也可以重复导入以覆盖更新

优化注释生成文档功能

支持通过s3协议上传附件

版本v2.9.15

安全更新

修复导入swagger文件的问题

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

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

支持runapi客户端的搜索功能

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

版本v2.9.14

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

选择目录时候可输入关键字搜索目录

在编辑页面时候可跳转去新建目录

完善页面排序功能

修复xss安全漏洞

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

支持runapi客户端的接口状态功能

支持runapi客户端的全局cookies功能

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