Showdoc-免费好用的团队API管理系统

最新推荐文章于 2024-10-10 08:28:04 发布

泪痕110

最新推荐文章于 2024-10-10 08:28:04 发布

阅读量957

点赞数 1

分类专栏： php 服务器文章标签： php nginx

本文链接：https://blog.csdn.net/ma_jian_ping/article/details/133274196

版权

php 同时被 2 个专栏收录

14 篇文章 0 订阅

订阅专栏

服务器

4 篇文章 0 订阅

订阅专栏

一、说明

做开发的朋友们肯定会经常使用API调试工具Postman，但是Postman只是一个测试工具，它并不能把我们测试好的接口直接生成文档分享给其他同事，相信很多小伙伴曾经头疼于编写接口文档，费时费力写出的文档却巨丑无比。今天我们就介绍一个免费，好用，可以私有化部署，支持团队管理的开源API文档管理系统：Showdoc

ShowDochttps://www.showdoc.com.cn/

ShowDoc 是一个非常适合 IT 团队的API文档分享工具，它可以加快团队之间沟通的效率，支持多系统，多途径管理API：

使用 markdown 语法来书写出美观的 API 文档、数据字典文档、技术文档
从程序注释中自动生成 API 文档
从搭配的 RunApi 客户端（类似 postman 调试工具）中一边调试接口、一边自动生成文档
使用Showdoc API接口集成到其他系统中

Showdoc服务自带web管理后台，并且Showdoc开源社区还免费提供了windows，mac，ios，android多平台的客户端工具，简直不要太爽。

二、部署核心服务

Showdoc是PHP开源项目，所以部署前，确保已安装PHP运行环境。

2.1：下载项目

cd /home/www/project
git clone https://github.com/star7th/showdoc.git
cd showdoc

2.2：安装项目依赖

wget https://getcomposer.org/download/1.9.0/composer.phar
php -d memory_limit=-1  composer.phar  update

项目依赖宝安装需要composer支持，这里使用的是离线版composer.phar程序，如果你的电脑上已经安装过composer，请自行调整一下命令内容

2.3：配置nginx服务器

server {
	listen       80;
	server_name  0.0.0.0;
	root         /home/www/project/showdoc;
	index index.php index.html;

	error_page  404              /404.html;
	location = /40x.html {
	}

	error_page   500 502 503 504  /50x.html;
	location = /50x.html {
	}

	location ~ \.php$ {
		root           /home/www/project/showdoc;
		fastcgi_pass   127.0.0.1:9000;
		fastcgi_index  index.php;
		fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;
		include        fastcgi_params;
	}

	location ~ /\.ht {
		deny  all;
	}
}

2.4：修改目录权限

chmod -R 777 /home/www/project/showdoc/install
chmod -R 777 /home/www/project/showdoc/Public
chmod -R 777 /home/www/project/showdoc/Sqlite
chmod -R 777 /home/www/project/showdoc/server/Application/Runtime