dodoliu / opendoc

在线接口文档管理系统

---

在线接口文档管理系统

---

该项目提供在线管理API文档的功能.

背景

如果你的公司正在开发一套或多套复杂的API,且这些API需要提供给未知的API调用方使用,且正在使用word或其它文档方式编写这些API说明文档.那么这个项目可能就是你需要的.

特性

• 功能拆分
  将API文档拆分为 品牌管理、接口管理、接口参数管理、接口返回参数管理、调用方管理。

• 权限控制
  使用devise+cancancan+rolify实现的权限管理系统，（需要说明的是：devise注册的用户和调用方管理的用户是两个概念）

• 实时反馈(待开发)
  在文档查看页面添加实时对话功能，免去当调用方在遇到问题后不能及时获得支持的尴尬体验。

下载安装

1, git clone https://github.com/dodoliu/opendoc.git
2, cd opendoc
3, bundle install
4, 配置数据库,默认使用mysql
5, 配置redis
6, 配置sidekiq

开发计划

接口管理的 调用demo 加入富文本编辑器 功能
文档查看页面加入 下载当前文档 功能
文档查看页面加入 实时对话 功能