showdoc for mac (API文档编辑工具) v1.0.2 苹果电脑版

Showdoc for Mac v1.0.2是一款强大的API文档编辑工具，专为苹果电脑打造。它界面简洁，操作便捷，能让开发者高效创建和管理API文档。我特别喜欢它的团队协作功能，以前大家分散编辑文档，版本混乱，沟通成本高。有了这个功能，团队成员可实时协作编辑，修改同步显示，大大提高了工作效率，让API文档的编写和更新变得轻松又准确。

showdoc(API文档编辑工具) 官方免费版

软件功能

API文档

APP、web前端与服务器常用API来进行交互

用ShowDoc可以非常方便快速地编写出美观的API文档

数据字典

好的数据字典可以很方便地向别人描述你的数据库结构

用ShowDoc可以编辑出美观的数据字典

说明文档

你完全可以使用 ShowDoc来编写一些工具的说明书

也可以编写一些技术规范说明文档以供团队查阅

团队协作

团队权限管理机制让团队良好地协同编写文档

免费开源

ShowDoc提供免费开源的版本

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

在线托管

www.showdoc.cc 提供安全稳定的在线文档托管服务

你可以放心地选择托管你的文档数据在云端

软件用途

1、API文档

随着移动互联网的发展，BaaS（后端即服务）越来越流行。服务端提供API，APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档，同时还将支持从代码文件中自动生成API文档

2、数据字典

一份好的数据字典可以很方便地向别人说明你的数据库结构，如各个字段的释义等。

3、说明文档

你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。

常见问题：

忘记了密码怎么办？

如果是使用在线ShowDoc（http://www.showdoc.cc ），忘记密码的话可联系xing7th@gmail.com，邮件中说明你的用户名和旗下项目名字。

如果是自己部署的ShowDoc，则首先根据前面安装文档进行升级，确保使用最新代码(划重点）。然后，根据安装方式的不同有不同的密码重置方式。

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

docker exec showdoc php /var/www/html/index.php home/common/repasswd

如果是手动安装php方式的，则在命令行中切换到web目录然后执行：

php index.php home/common/repasswd

以上命令会把管理员showdoc的密码重置为123456 。用此密码登录管理后台即可管理普通用户以及项目。建议登录后修改密码。

若修改密码出错，请确保自己采用最新版代码。

若是自行部署开源版ShowDoc，请确保自己安装好了docker或者PHP运行环境

安装PHP环境可以参考：http://www.showdoc.cc/php

由于系统、软件版本等情况各不相同，所以如果你一直安装PHP环境失败，可以尝试使用Docker方式部署：http://www.showdoc.cc/help?page_id=65610

如果你觉得手动安装麻烦，或者觉得后期维护不方便，则可以使用在线ShowDoc http://www.showdoc.cc/

开源版showdoc如何连接数据库

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

错误提示 “Could not find driver”

请安装php-pdo 和 pdo_sqlite 。

对于Windowns服务器，在php.ini里面把”extension=php_sqlite.dll”和”extension=php_pdo_sqlite.dll”启用以便开启对SQlite的支持；

Linux服务器安装php5.3以上版本时理论上默认是开启了php-pdo和pdo_sqlite的。如果你安装的PHP依然没有，则可搜索网络教程安装之。

错误提示”General error: 11 database disk image is malformed”

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

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

可以使用mysql数据库吗

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

验证码不显示

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