还在为项目文档发愁,还在忍受无文档的代码,试试它吧

文档工具

Journeys end in lovers' meeting. 漂泊止于爱人的相遇。

无论在我们日常开发还是前后端人员沟通的过程中,乃至于项目交接中,完善的文档是必不可少的,缺乏项目文档简直是一场噩梦。

今天介绍几个项目文档管理工具,帮助你高效的管理项目文档.

Postman

postman 是一个上手简单的API文档管理工具,其可进行接口测试,文档保存分类,团队分享,并且具备简单的重复测试功能,相信大家并不陌生

优点

  1. 简单方便,断网可用
  2. 用户多,可以统一使用
  3. 可进行重复测试

缺点

  1. 多人协作不方便
  2. 人员、权限无法管理
  3. 无项目文档功能

eolinker

官网:https://www.eolinker.com/#/

eolinker 是收费的,不过他可以免费 10 个用户,可以满足小型团队使用,其提供项目管理,人员权限管理、数据库结构管理、自动化测试、mock、文档管理等

在这里可以创建项目

项目创建成功后可以随意的添加Api

添加API的功能完成的还不错,可以根据不同的状态码,定义正常消息和错误消息以及接口详细文档,并且在创建文档的时候可以进行测试

通过列表可以查看现在所有的API信息

当多次对同一个API文档进行修改时,可以查看版本信息,方便回滚

文档管理功能,提供了Markdown和富文本两种形式

同时还有协作功能,可以自己尝试一下

优点

  1. 使用简单方便
  2. 支持mock并提供了自动化测试
  3. 有协作人员管理功能
  4. 支持项目文档
  5. API修改会保留历史版本,方便回滚

缺点

  1. 10以上使用收费
  2. 断网不可用

YApi

官网:https://yapi.ymfe.org/

github:https://github.com/ymfe/yapi

添加项目

接口列表

添加接口添加接口是需要先添加基本信息然后通过编辑功能进行完善

导入接口支持导入 Postman HAR Swagger 格式文档

优点

  1. 代码开源,可独立部署
  2. 使用简单方便
  3. 支持mock
  4. 可协作使用
  5. 支持项目文档wiki

缺点

  1. wike 未发现层级关系
  2. 断网不可用
  3. 协作未发现权限功能功能

RAP

官网:http://rap2.taobao.org/ 教程 https://www.jianshu.com/p/869fa17dc9d4?from=singlemessage

优点

  1. 代码开源,可独立部署
  2. 使用简单方便
  3. 支持mock
  4. 可协作使用
  5. 支持 导出Postman Collection

缺点

  1. 断网不可用
  2. 未发现支持项目文档

Swagger

曾经使用过一段时间,就不截图了

下面给个文档 https://blog.csdn.net/sanyaoxu_2/article/details/80555328

优点

  1. 文档与代码保持同步
  2. 使用简单方便

缺点

  1. 有代码侵入性
  2. 无文档管理功能
  3. 对应项目停止后,就无法查看文档
  4. 不支持 mock
  5. 未发现支持项目文档

原文发布于微信公众号 - 777开发日记(gh_773193545262)

原文发表时间:2018-10-23

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏杂烩

GitHug备忘 原

作为开源代码库以及版本控制系统,Github拥有140多万开发者用户。随着越来越多的应用程序转移到了云上,Github已经成为了管理软件开发以及发现已有代码的首...

6850
来自专栏即时通讯技术

IM消息送达保证机制实现(二):保证离线消息的可靠投递1、前言 2、学习交流3、IM消息送达保证系列文章4、消息接收方不在线时的典型消息发送流程5、典型离线消息表的设计以及拉取离线消息的过程6、上述流

本文的上篇《IM消息送达保证机制实现(一):保证在线实时消息的可靠投递》中,我们讨论了在线实时消息的投递可以通过应用层的确认、发送方的超时重传、接收方的去重等手...

15420
来自专栏desperate633

session和cookies会话机制详解session management会话管理的原理servlet&jsp中的session会话管理机制cookie的更多用处

web请求与响应基于http,而http是无状态协议。所以我们为了跨越多个请求保留用户的状态,需要利用某种工具帮助我们记录与识别每一次请求及请求的其他信息。举个...

10710
来自专栏大数据实战演练

Linux NTP时钟同步

时钟同步在大数据方向,用到的地方很多。举个例子来说吧,像Zookeeper、RegionServer服务都是需要实时和各节点进行通信的。假如各节点差超过30s,...

82620
来自专栏Java架构沉思录

从一笔金币充值去思考分布式事务

考虑支付重构的时候,自然想到原本属于一个本地事务中的处理,现在要跨应用了要怎么处理。拿充值订单举个栗子吧,假设:原本订单模块和账户模块是放在一起的,现在需要做服...

12330
来自专栏知晓程序

电商/票务类小程序必读,如何用小程序推送消息?

通常,服务方向用户推送的消息都带有通知性质,文案也相对固定。服务方将这类固定的文案制作成模板,这些文案就可以快速重复使用。

14420
来自专栏腾讯Bugly的专栏

《移动端本地 H5 秒开方案探索与实现》

对 APP 里的一些使用 H5 实现的功能模块,一般体验都比原生差,那么怎么提高h5加载速度?优化 h5 体验?

1.5K130
来自专栏美团技术团队

【技术博客】Cache应用中的服务过载案例研究

简单地说,过载是外部请求对系统的访问量突然激增,造成请求堆积,服务不可用,最终导致系统崩溃。本文主要分析引入Cache可能造成的服务过载,并讨论相关的预防、恢复...

35050
来自专栏杨建荣的学习笔记

使用Linux命令发送邮件(r2笔记94天)

在平时的工作中,可能很多环境都有自己的内网环境,如果发生一些问题的时候,可以通过内网环境发送邮件到指定的邮箱中。这种略显智能的方式可能在很多工作场景中使用,一般...

39250
来自专栏EAWorld

8种至关重要OAuth API授权流与能力

在本文中,Curity的Daniel Lindau概述了重要的OAuth授权流程和能力。

8810

扫码关注云+社区

领取腾讯云代金券