项目中管理工具

  • 接口文档管理

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私服

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,377评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,390评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,967评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,344评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,441评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,492评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,497评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,274评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,732评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,008评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,184评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,837评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,520评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,156评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,407评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,056评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,074评论 2 352

推荐阅读更多精彩内容