showdoc安装 - 在线API文档

---

以下内容大部分来自官网

---

1. showdoc 介绍

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

2. 官方文档地址

https://www.showdoc.com.cn/help/1385767280275683

3. showdoc 安装

官方提供了几种安装方式，这里用自动化脚本安装

  #下载脚本并赋予权限
   wget https://www.showdoc.com.cn/script/showdoc;chmod +x showdoc;

  #默认安装中文版。如果想安装英文版，请加上en参数，如 ./showdoc en
  ./showdoc

3.1 下载的脚本（showdoc）大概内容

vim ./showdoc 之后 可看到以下内容

#!/bin/bash
SHOWDOC_SCRIPT_VERSION='2.0'
if [[  -n "$1" ]] ; then
        action=$1
else
        action='install'
fi
if [ "$action" == "start" ] ;then
        sudo -s  service docker start
        sudo -s docker start showdoc
        exit 1
fi
if [ "$action" == "restart" ] ;then
        sudo -s docker restart showdoc
        exit 1
fi
if [ "$action" == "stop" ] ;then
        sudo -s docker stop showdoc
        exit 1
fi
if [ "$action" == "update" ] ;then
        DATE=$(date +%Y%m%d_%H%M%S_%N)
        if [ ! -d "/showdoc_data/html" ]; then
                echo  "Directory /showdoc_data/html does not exist"
                echo "/showdoc_data/html 目录不存在"
                exit 1 ;
        fi
        # 判断语言
        result=$(tail -n 1000 /showdoc_data/html/web/index.html | grep zh)
        if [ ! -z "$result" ] ; then
                sudo -s docker pull registry.cn-shenzhen.aliyuncs.com/star7th/showdoc
                sudo -s docker tag registry.cn-shenzhen.aliyuncs.com/star7th/showdoc:latest star7th/showdoc:latest
        else
                sudo -s docker pull star7th/showdoc
        fi

        sudo -s mv /showdoc_data/html /showdoc_data/html_bak_${DATE}

        sudo -s mkdir -p /showdoc_data/html
        sudo -s chmod  -R 777 /showdoc_data/html

根据以上内容 大概可看到，脚本内容是使用docker安装脚本的，所以服务器中无docker的，可以下载一个docker试试

3.2 启动、停止等等

步骤3下载的 ./showdoc 可以放在任意目录，针对该脚本执行想要的操作

 #下面附上脚本其他命令，以便管理showdoc时可以用得上。

 #停止
 ./showdoc stop 

 #重启
 ./showdoc restart

 #升级showdoc到最新版
 ./showdoc update

 #卸载showdoc
 ./showdoc uninstall

4. 说明

showdoc的数据都会存放在 /showdoc_data/html 目录下
安装之后，打开网址 http://服务器IP:4999
默认账号密码是：showdoc/123456