接口文档管理工具showDoc

随着互联网的发展，前后端分离已成为互联网项目开发的业界标准使用方式。

由此而产生的前端开发工程师和后端开发工程师的沟通效率问题。

推荐一个应此而生的文档管理工具---showdoc

showdoc官网

一、介绍

1.ShowDoc是什么

每当接手一个他人开发好的模块或者项目，看着那些没有写注释的代码，我们都无比抓狂。文档呢？！文档呢？！Show me the doc ！！
程序员都很希望别人能写技术文档，而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版，想着新建的word文档放在哪个目录等各种非技术细节。
word文档零零散散地放在团队不同人那里，需要文档的人基本靠吼，吼一声然后上qq或者邮箱接收对方丢过来的文档。这种沟通方式当然可以，只是效率不高。
ShowDoc就是一个非常适合IT团队的在线文档分享工具，它可以加快团队之间沟通的效率。

2.功能

权限管理
- 公开项目与私密项目
  - ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问，而私密项目则需要输入密码验证访问。密码由项目创建者设置。
- 项目转让
  - 项目创建者可以自由地把项目转让给网站的其他用户。
- 项目成员
  - 你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑，但不可转让或删除项目（只有项目创建者才有权限）
- 团队管理
  - 利用showdoc的团队功能你可以更好地进行团队协作
编辑功能
- markdown编辑
  - ShowDoc采用markdown编辑器，无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown，请在搜索引擎搜索”认识与入门 Markdown”
- 模板插入
  - 在ShowDoc的编辑页面，点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后，剩下的就是改动数据了，省去了很多编辑的力气。
- 历史版本
  - ShowDoc为页面提供历史版本功能，你可以方便地把页面恢复到之前的版本。
多平台

showdoc支持网页版、手机app版和电脑客户端版。客户端地址可见：https://www.showdoc.cc/clients

二、示例

接口文档管理工具showDoc相关推荐

盘点 8 款好用的 API 接口文档管理工具
随着互联网的普及和发展,API 接口已经无处不在.它已经在 Web 应用程序.移动应用程序.云计算.物联网.人工智能等领域中得到广泛应用. 例如,在金融行业中,API 接口可以被用于构建支付服务.银行 ...
在线接口文档管理工具（小幺鸡）使用说明
在线接口文档管理工具(小幺鸡)使用说明前言小幺鸡的地址:http://www.xiaoyaoji.cn/ 几大看点: 在线接口测试: 可视化编辑与分享: 代码开源.可以离线部署. 下面简单介绍下怎 ...
几款接口文档管理工具
在项目开发测试中,接口文档是贯穿始终的.前后端开发需要在开发前期进行接口定义并形成文档,QA在功能测试和接口测试的环节也需要依赖于这些接口文档进行测试.接口文档往往以最简单的静态文档的形态存在.然而在 ...
一款强大的API接口文档管理工具（Smart-Doc + Torna）
[本文由龙飞同学供稿] 在团队协作开发项目的时候,接口文档承担着向其他开发人员说明接口相关信息的重要任务,因此,一份清晰而又相近的接口文档至关重要. 但是,写接口文档的痛苦想必各位开发人员都体验过,明 ...
接口文档管理工具-Postman、Swagger、RAP、DOClever
在项目开发测试中,接口文档是贯穿始终的.前后端开发需要在开发前期进行接口定义并形成文档,QA在功能测试和接口测试的环节也需要依赖于这些接口文档进行测试.接口文档往往以最简单的静态文档的形态存在.然而在 ...
接口文档管理工具-Postman、Swagger、RAP
在项目开发测试中,接口文档是贯穿始终的.前后端开发需要在开发前期进行接口定义并形成文档,QA在功能测试和接口测试的环节也需要依赖于这些接口文档进行测试.接口文档往往以最简单的静态文档的形态存在.然而在 ...
强烈推荐在线接口文档管理工具小幺鸡小团队可以省掉测试了
在朋友那儿看到一个不错的在线文档管理工具主要特点 : 在线接口测试在线测试,方便前后端开发,降低错误率. 支持:xml.json.txt.binary.websocket 可视化编辑与分享可视化 ...
接口文档管理工具--Yapi安装
前言现在咱们做的项目都是前后端分离的,这样就可以保证前端和后端可以同时进行,但是同时会出现一个问题->前端不知道咱们服务器的接口是怎么定义的,不知道里面的参数应该如何传递.这个时候就需要使用接 ...
分享一个强大的在线写API接口文档的工具showdoc
网站地址:https://www.showdoc.cc 第一步:注册第二步:填写注册信息,这里填写用户名和密码即可,用户名不可重复,注册登录后可以绑定邮箱. 也可以不注册查看示例决定要不要使用这个网 ...

接口文档管理工具showDoc

一、介绍

二、示例

接口文档管理工具showDoc相关推荐

最新文章

热门文章