项目中管理工具
-
接口文档管理
1、最简单的就是拿excel表格,在收个sheet里面建一个总的接口目录,然后每一项(可以是单独的接口,可以是一个模块的所有接口)设置跳转链接,跳转到相应的接口页面,这个excel表格可以提交的svn上方便大家及时更新和查看。
2、利用showdoc等第三方平台
showdoc网站打开看着不起眼,但里面的内容相当的强大,重点说下特点
1:支持markdown语法(所有的api接口写作现在都支持这个吧,因为他现在太方便了)
2:支持多用户协作,你可以在项目下面随意添加多个用户一起完成api文档的写作。
3:可以分享并导出项目,生成需要的文档格式如doc,可以离线浏览
4:支持响应式,手机电脑同样精彩
5:支持项目转让
6:支持模版插入
7:支持历史版本,你可以把操作恢复到以前的版本。
8:showdoc完全开源
9:可以部署到自己的服务器
10:如果在线使用,可以设置自己的个性域名,也可以对文档进行加密,浏览者需要密码才能访问
11:可以通过一个在线测试api的工具,直接生成markdown,你几乎不用写代码就能过所有的参数自动生成
3、springboot+swagger自己来实现一个接口管理页面。
image.png
截图中每一个项目是一个条目,条目下有很多个接口,每个接口有请求参数说明、返回数据说明、返回示例展示,还可以直接对参数进行编辑访问获取新的返回示例。
-
项目管理redmine(Redmine是用Ruby开发的基于web的项目管理软件,是用ROR框架开发的一套跨平台项目管理系统)
● 多项目和子项目支持
● 里程碑版本跟踪
● 可配置的用户角色控制
● 可配置的问题追踪系统
● 自动日历和甘特图绘制
● 支持 Blog 形式的新闻发布、Wiki 形式的文档撰写和文件管理
● RSS 输出和邮件通知
● 每个项目可以配置独立的 Wiki 和论坛模块
● 简单的任务时间跟踪机制
● 用户、项目、问题支持自定义属性
● 支持多 LDAP 用户认证
● 支持用户自注册和用户激活
● 多语言支持(已经内置了zh简体中文)
● 多数据库支持(MySQL、SQLite、PostgreSQL)
● 外观模版化定制(可以使用 Basecamp 、Ruby安装)* 项目论坛* 简单实时跟踪功能* SCM in集成 (SVN, CVS, Git, Mecuial, Bazaa and Dacs)
-
代码管理Git,可以自己搭建一个服务器,比如gitlab
git 是一种版本控制系统,是一个命令,是一种工具
gitlib 是用于实现git功能的开发库
github 是一个基于git实现的在线代码托管仓库,包含一个网站界面,向互联网开放
gitlab 是一个基于git实现的在线代码仓库托管软件,你可以用gitlab自己搭建一个类似于
github一样的系统,一般用于在企业、学校等内部网络搭建git私服