多人维护一份文档必须知道的管理网站-接口的github

news/2024/4/28 20:13:16/文章来源:https://blog.csdn.net/weixin_34297704/article/details/89026054

传统维护文档方式
1.word格式文档
2.在线markdown文本

API管理的痛点
  • API接口在设计时往往需要编写大量的文档,而且编写完成之后还会经常改动,文档编写维护工作量大。
  • 接口文档编写好后,实际的代码可能会与文档有出入,这个时候文档是不准确的,文档与代码保持修改同步也是一个很大的工作量。
  • 随着接口版本的迭代,接口文档需要同步更新。
  • 有些时候接口会成为对接双方的开发进度瓶颈,因为接口调用会有依赖,类似app的项目,前端会需要调用后端接口,接口功能不实现会影响前端开发进度。
  • 接口开发完以后,做接口测试不方便,特别是接口数量多,参数复杂的情况,测试工作量大。
  • 接口在版本迭代后,旧的接口常常需要做回归测试,这个工作量也是非常大的。
    word格式在更新接口文档有很大的局限性,markdown文本在跟踪开发成员更新情况也很不方便。
  • 传统维护文档的方式面临接口文档乱,格式不统一,参数填写不清晰等问题

上述分析来自 API接口管理之道

解决多人维护的问题

参考github多人维护代码思路,其采用分支的模式,各成员分工后独立开发,最后合并在一起,在实际应用中,单个接口一般是由一个程序员开发,故只需一个仓库,各成员共同维护即可。对于接口的多人维护更多的考虑是修改文档同步更新以及明确显示各成员开发进度等
而在eolinker是我看过记录最详尽的接口管理网站

eolinker

  • 接口文档
    接口文档

十分清晰的接口文档,格式统一,明确的接口分组。

接口详情页
接口详情里面的信息非常详细,接口的值可能性非常实用,支持富文本和markdown语法的接口详情

  • 成员管理
    成员管理

输入队友的注册信息就可以邀请进来,分别设置了权限,比如只有管理员有导出项目文档的权限,毕竟项目的接口文档是隐私嘛,一定程度保证接口安全。

  • 项目动态
    项目动态

开发人员了修改接口文档,操作一目了然。方便多人协作时开发人员的交流

  • 接口回收站

接口回收站
错删误删?不存在的,接口回收站随时可以还原接口数据,手残的我,完全不担心

eolinker通过项目动态和协作管理等实现了多人维护一份文档,在我看来就是接口的github,对于个人开发者也很实用,欢迎使用后和我交流文中没发掘且利于合作的功能~

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.luyixian.cn/news_show_814488.aspx

如若内容造成侵权/违法违规/事实不符,请联系dt猫网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

前端开发学习网站

1、http://www.runoob.com 转载于:https://www.cnblogs.com/goodboy-heyang/p/4678600.html

apache virtualhost配置 apache配置多个网站

第一步 apache下httpd.conf文件 启用模块LoadModule vhost_alias_module modules/mod_vhost_alias.so 第二步 apache下httpd.conf文件&#xff0c;启用文件Virtual hosts# Virtual hostsInclude conf/extra/httpd-vhosts.conf NameVirtualHost *:80 <VirtualHost *:80> D…

120行代码爬取电子书网站

无聊的练习。。。貌似网站真的有毒&#xff0c;我的电脑多了一个广告。。。fuck 换做好几年前我们看电子书都是在网上下载txt文件的书籍&#xff0c;现在各种APP阅读软件实在方便太多。 那么txt的文件就没用了吗&#xff1f;不呀&#xff0c;可以下载放kindle阅读呀&#xff0…

前台模板 海豚php_WP网站模板开发中,怎样给分类目录添加SEO标题和关键词?

作为一个wordpress网站的站长&#xff0c;都希望自己的网站在百度或谷歌搜索引擎上的排名好。这时&#xff0c;我们除了要做好wordpress网站的内容之外&#xff0c;还要对wordpress网站做好相关的SEO优化。在前面的章节中&#xff0c;我们介绍了wordpress网站首页的SEO优化&…

静态资源文件自动压缩并替换成压缩版本(大型网站优化技术)

原文:静态资源文件自动压缩并替换成压缩版本&#xff08;大型网站优化技术&#xff09;这一次&#xff0c;我总结和分享一项大型网站优化技术&#xff0c;那就是在项目中自动压缩静态资源文件&#xff08;css、js&#xff09;&#xff0c;并让网站自动加载压缩后的资源文件。当…

临阵磨枪,血拼季网站优化的最后三板斧

2019独角兽企业重金招聘Python工程师标准>>> 【编者按】本文作者 Dennis Callaghan 目前就职于 Callaghan&Partners。本文中&#xff0c;作者分享了购物高峰期提高网站性能的三个建议&#xff0c;帮助电商网站解决性能难题&#xff0c;提升用户体验&#xff0c;…

用户访问网站的完整流程

在浏览器输入想要访问的域名之后&#xff0c;浏览器会进行域名解析获得IP地址&#xff0c;在经过TCP的连接&#xff0c;实现数据的传输就会有两种报文&#xff0c;及请求报文和响应报文。最终才能实现通信。因此想要实现通信&#xff0c;就得先弄懂DNS的解析原理以及TCP连接通道…

网站定位之---根据IP获得区域

记得以前做一个培训机构网站时候需要定位&#xff0c;那时候用的搜狐的api&#xff0c;不是很精准。 demo:https://github.com/dunitian/LoTCodeBase/tree/master/NetCode/3.常用技能/06.Position/01.IPToPosition 后来做电商的时候用的新浪的api&#xff0c;感觉还行&#xff…

网站收录工具(php导航自动收录源码)_让百度快速收录网站的办法(简单可行)...

让百度快速收录网站最直接的方式是把网站链接提交给百度&#xff0c;能让蜘蛛快速发现页面而不是等着百度蜘蛛自己发现&#xff0c;收录慢不说&#xff0c;如果网站结构有问题&#xff0c;可能还抓取不到某些页面&#xff0c;从而不收录。百度提交网站收录的方式有快速收录和普…

java支付宝开发-02-手机网站支付

源码已上传github&#xff0c;欢迎专注&#xff1a;https://github.com/shirayner/alipay-wap 一、基础部分 1.手机网站支付产品介绍 1.1 阅读官方介绍&#xff1a; 手机网站支付产品介绍 1.2 看完官方的介绍之后&#xff0c;可以做出如下总结&#xff1a; 通过接入此接口&…

大型网站系统架构的演化

2019独角兽企业重金招聘Python工程师标准>>> 前言 一个成熟的大型网站&#xff08;如淘宝、京东等&#xff09;的系统架构并不是开始设计就具备完整的高性能、高可用、安全等特性&#xff0c;它总是随着用户量的增加&#xff0c;业务功能的扩展逐渐演变完善的&#…

可以发外链的网站_SEO优化就是写文章发外链吗?到底该怎么优化一个网站呢?...

点击箭头处“蓝色字”&#xff0c;关注我们哦&#xff01;&#xff01;在某个群里有很多“大侠”对SEO优化很是有误解&#xff0c;有的人说优化就是使劲的发文章&#xff0c;把外链做到极致就可以了&#xff0c;也有的人对优化不屑一顾&#xff0c;觉得优化没技术含量&#xff…

网站输入正确账号密码页面刷新一下_对某钓鱼网站的一次渗透测试

文章作者&#xff1a;Mochazz文章来源&#xff1a;Mochazz的博客原文链接&#xff1a;https://mochazz.github.io/2019/07/01/对某钓鱼网站的一次渗透测试/周末在某个CTF群偶然看到这个钓鱼网站&#xff1a;http://gggggg.cn (声明&#xff1a;本文中出现的域名、IP均被替换&am…

免密登录_以Airbnb为例,用selenium免密登录网站

大家好&#xff0c;这篇文章介绍了如何通过selenium利用cookie免密登陆网站&#xff08;第一次写文章 &#xff09;zzh2027/zzh2027.github.io​github.comfrom selenium import webdriver from selenium.webdriver.common.keys import Keys## 模拟键盘用的包 from selenium.we…

SEO流量定义,什么是搜索引擎优化策略营销?

SEO流量定义&#xff0c;什么是搜索引擎优化策略营销&#xff1f; 搜索引擎优化&#xff08;SEO&#xff09;看起来非常简单。你挑选几个关键词&#xff0c;然后瞧&#xff01;您的网页针对搜索引擎优化进行了优化 还没。 很多人都明白SEO的基本原则&#xff0c;但在过去的十年…

疯狂的多域名富关键词网站优化策略

疯狂的多域名富关键词网站优化策略 SEO中一个被很多人看重的排名因素就是根域名含有关键词&#xff0c;中文也一样&#xff0c;就是含有拼音&#xff0c;在相同的条件下&#xff0c;显然根域名含有关键词就有较好的排名&#xff0c;有一些SEO.er利用搜索引擎的这个排名策略&…

实时搜索SEO如何应对

实时搜索(Real-time Search)已经大势所趋&#xff0c;不是SEO不明白&#xff0c;是互联网变化太快&#xff0c;每天都有新名词&#xff0c;每天都有新主题&#xff0c;搜索引擎如何为用户及时的返回丰富又有意义的即时结果&#xff0c;Google推出Caffeine也正是适应这种趋势&am…

国内优秀的免费素材网站大比拼

奇遇网络专业提供seo优化服务&#xff0c;seo优化外包&#xff0c;免费建站模板&#xff0c;免费wordpress模板&#xff0c;DIVCSS模板,几千种免费网页模板&#xff0c;收集最好最全的html5模板及css3模板,html5是目前最前瞻的网页技术,本站为大家提供免费技术交流平台。 国内优…

ASP.NET新建解决方案和网站

新建解决方案和网站 1.打开visual studio&#xff0c;选择新建项目&#xff0c;然后选择解决方案。 2.解决方案建好之后&#xff0c;右键点击解决方案选择新建网站。注意&#xff0c;路径。我在solution1文件夹下面又建了一个site文件夹。 3.右键点击site选择添加新项。 好了&a…

网站架构演化阶段

网站架构演化阶段 网站架构需要工程师从全局把握一个网站的前台、后台&#xff0c;要知道什么地方会有瓶颈&#xff0c; 对网站的可扩展性、安全性等需要有一个成熟的把握。 下面说的几个阶段可以了解网站架构演化。 1&#xff09;单机部署 最简单的情况&#xff0c;可以把各个…