你注意到了吗？修改API文档也需要规范！
2024-09-03 02:22:04
关于API接口文档的内容和格式规范的文章，之前也有写过，网上也有不少写的比我还好的，就不赘述了，今天想说的是一个很容易被忽略的点，修改API文档的规范：版本控制。
示例
拿Eolinker来演示一下流程，我们在通过API文档完成当前的API项目后，新增了一个需求，需要修改某个接口。
这时候可以新建API版本，给变动后的接口设置版本号，得到修改前和修改后的不同版本API。
同时，Eolinker有自动生成和绑定不同版本API文档的功能，完成API项目后，会自动生成规范的API文档，并给不同的版本绑定不同的API文档。通过Eolinker生成的API文档支持在线查看，也支持不同格式的文档导出和对比。
结言
一套成熟的API文档，是不允许随意修改接口的，随意修改API文档，很容易造成开发进度和项目的混乱。这时候比较规范的方法，就是加入版本控制了。
演示工具：www.eolinker.com
最新文章
- 释放Android的函数式能量（I）：Kotlin语言的Lambda表达式
- [Web API] Web API 2 深入系列(2) 消息管道
- 使用 CSS3 实现 3D 图片滑块效果【附源码下载】
- 我的android学习经历
- Java常用类库——Runtime
- Linux Kernel中获取当前目录方法(undone)
- mysql-关于Unix时间戳（unix_timestamp）
- .net 网站预编译命令
- leetcode 38
- linux shell 命令学习(3) split - split a file into pieces
- vs2008团队资源管理器安装步骤
- rfid门禁系统笔记
- hadoop-1.1.2集群搭建
- H5之canvas简单入门
- VOIP概述
- 校友信息管理&SNS互动平台之前言、目录及说明
- 第一节：Scrapy开源框架初探
- javascritp封装的类似java HashMap的类
- 基于tomcat为了应对高并发模型实现webserver
- J.U.C-三剑客[semaphore\CyclicBarrier\CountDownLatch]