API 文档管理系统推荐

#system #project

一直在寻找一个好用 api 管理系统。
之前接口少,然后直接都是用 word 写的接口文档,然后每次更新就要发一个 word 给我。
那效率真是感人!!!文件夹里全是 xxx.docx xxx(1).docx xxx(2).docx ……
找过几个都不能满足要求。

我们的需求就几点:
1.要有权限管理,因为接口没有加密,所以不能外流出去,只限团队内查看。
2.编写、发布简单(很多都可以直接用 markdown 编写)。
3.开源,一个是避免费用问题,还有就是万一要定制自己的需求的话也可以修改。

0x00 推荐两款管理软件

后来网上一番搜索还是找到了一些符合需求的开源项目。

1.rap
阿里妈妈MUX团队出品!阿里巴巴都在用!
优点:组织架构管理强大,文档全,还有视频,教程上手快。

2.ShowDoc
这个简单轻量,支持 markdown 编写, PHP 语言写的。

肯定还有其他很好的,以后有更好的肯定在这边更新出来。

0x01 安装 rap

因为 rap 是 Java 编写的,平常主要用的也是 Java ,所以选择了 RAP。

因为我选择了自己部署,懒的动的同学可以选择使用其线上已经部署好的产品。

下面介绍一下安装过程中遇到的问题,希望能给大家一些帮助吧。

依赖的其他软件有:mysql、tomcat、redis。
因为前两个都已经有了,所以只需要安装redis。

安装 Redis 的时候碰到了几个错误

error1:

sh: ./mkreleasehdr.sh: Permission denied

//权限不够  

cd src/
chmod 777 mkreleasehdr.sh

error2:

zmalloc.h:50:31: error: jemalloc/jemalloc.h: No such file or directory
zmalloc.h:55:2: error: #error "Newer version of jemalloc required"
// 原因是jemalloc重载了Linux下的ANSI C的malloc和free函数。解决办法:make时添加参数。

make MALLOC=libc

最后安装成功。

还有注意一下就是,rap 的 content path 只能是根路径,所以需要把下载的 war 包名改成 ROOT.war 才行。

There are no comments on this post.