Yapi与 Web API 接口管理工具

924 阅读2分钟

「API 接口管理」和 「API设计和开发」,是不同的

Yapi 是管理,和设计辅助工具


Web API 项目(Web 分布式系统的模块)
	L 接口管理
		L API 开发分配
		E API 版本更新通知
	E 接口设计
		L API 功能的设计和开发(设计案)
			L 架构(结构)设计
				L API 设计分 标准REST设计
				E 与非标准REST设计
			E (架构)模块具体设计
				L 接口名(资源名URI,加操作方法)
					L 资源 名词 ,单数还是复数
					E 嵌套资源的层次
					E 资源集合的过滤,搜索,和分页
						L 
				E 数据(资源表现,如json)
 				E 异常处理 (前面总结过,编写独立程序模块,考虑异常处理是开发者基本素养)
					L HTTP状态码
				E 安全设计
					L 协议安全
						L HTTPS
					E 应用安全
						L USER AUTH
				E 性能设计
		E API 文档
			L YAPI系统上的设计案本身也是 文档,格式化导入出来则更友好的 文档
		E API 测试
			L 测试前端(mock 后端)
			E 测试后端(像postman)
		E API 模拟

一切开发(设计)的复杂性,源于 Web 分布式系统的特性

与本地 普通应用程序相对比

  • 1 模块CS模式, 一对多
  • 2 基于 公共的 网络,考虑安全,网络性能等
  • 3 应用程序 本身规模,文档,团队开发等任务

定义好API后,为什么要测试?

定义好API后,为什么要测试?
	L API 本身是指 模块的功能接口,是Web 模块 API
	E Web API,由于「模块的形态」与一般程序(例如JS函数)不同,所以具体测试活动有不同
		L 普通函数模块
什么是测试?模块API测试?
	L 就是模仿用户去“用”一API的功能,看是否符合功能需求
		L “用”API 可是由人执行,也可以用 程序,后者就是 自动化测试
			L 很多中间性模块,只能使用 自动化测试
如何做测试 模块功能,测试 WEB 模块 API?
	L 1 自动化测试工的话,一般使用 自动化测试框架
	E 2 Web 模块测试,使用postman