接口测试的使用范围
2024-05-10 17:31
1. 接口测试的使用范围
接口测试一般会用于多系统间交互开发，或者拥有多个子系统的应用系统开发的测试。接口测试适用于为其他系统提供服务的底层框架系统和中心服务系统，主要测试这些系统对外部提供的接口，验证其正确性和稳定性。接口测试同样适用于一个上层系统中的服务层接口，越往上层，其测试的难度越大。接口测试在淘宝的应用是一个自下而上的发展过程。接口测试实施在多系统多平台的构架下，有着极为高效的成本收益比，接口测试天生为搞复杂性的平台带来高效的缺陷监测和质量监督能力。平台越复杂，系统越庞大，接口测试的效果越明显。接口测试的目的是测试接口，尤其是那些与系统相关联的外部接口，测试的重点是要检查数据的交换，传递和控制管理过程，还包括处理的次数。外部接口测试一般是作为系统测试来看待的。不是所有的团队都可以在一个隔离的测试环境中进行测试工作的，因此使得对外部接口的测试显得困难。我们应该确保较早地与相关的组织协调好并确定进行外部接口测试的方案。有时候相关的组织只是人工的静态的审阅一次数据而并不真正的用这些数据来测试。等等这些都增加了实际测试执行中遇到的风险，但有些时候是可以避免的。假设/预处理项目的责任人/开发人员必须已经成功完成了单元测试、功能测试和集成测试，一些错误都已经被列出。测试策划人员拿到的是最新版本的源代码期望正如前面提到过的那样，最重要的是关于外部接口的测试，这需要依赖于外部接口的相关数据，而这可能是极其复杂的测试项目需要一系列的测试计划以及和外部组织的协调工作，主要包括：负责人选预定的测试时间如果没有合适的测试环境，测试可能需要在周末或者工作时间以外的时间里进行需要什么类型的测试用例，需要多少以及这些用例分别是用来测试什么的提供测试用例的副本及相关文件给相关合作人员如果外部组织有一些特殊用例需要执行，我们也需要拿到相关副本及文件谁将提供测试数据，这些测试数据包括哪些方面的内容，是以什么形式给出的（纸质，电子档还是只是一些数据的底稿并且需要相关的人员整理成可用的数据）谁将对测试结果进行确认并且判别这些数据就是我们所需要的每隔多久时间我们需要各路人马聚在一起讨论测试中遇到的问题以及测试进度所有正常的情形和异常的情形都需要测试，测试的各个方面（数据的各个出口，路径，入口）都需要尽可能考虑周全。我们不仅需要用一般大小的数据量去测试，也需要用预期的或者规定的最大数据量去测试如果允许的话，我们还可以测试各个部分处理一批数据的时间数据如果因修复bug等改动代码从而改变了接口的某一端，相关的决定，到期时间，再测试等过程都应该被记录在案，并且分发到各个相关组织或人员。
2. API 设计规范
设计时通过将请求和响应之间的不同部分隔离来让事情变得简单。保持简单的规则让我们能更关注在一些更大的更困难的问题上。
请求和响应将解决一个特定的资源或集合。使用路径（path）来表明身份，body来传输内容（content）还有头信息（header）来传递元数据（metadata）。查询参数同样可以用来传递头信息的内容，但头信息是首选，因为他们更灵活、更能传达不同的信息。
所有的访问API行为，都需要用TLS通过安全连接来访问。没有必要搞清或解释什么情况需要TLS 什么情况不需要TLS，直接强制任何访问都要通过 TLS。
理想状态下，通过拒绝所有非TLS请求，不响应http或80端口的请求以避免任何不安全的数据交换。如果现实情况中无法这样做，可以返回403 Forbidden响应。
把非TLS的请求重定向(Redirect)至TLS连接是不明智的，这种含混/不好的客户端行为不会带来明显好处。依赖于重定向的客户端访问不仅会导致双倍的服务器负载，还会使 TLS 加密失去意义，因为在首次非TLS调用时，敏感信息就已经暴露出去了。
制定版本并在版本之间平缓过渡对于设计和维护一套API是个巨大的挑战。所以，最好在设计之初就使用一些方法来预防可能会遇到的问题。
为了避免API的变动导致用户使用中产生意外结果或调用失败，最好强制要求所有访问都需要指定版本号。请避免提供默认版本号，一旦提供，日后想要修改它会相当困难。
最适合放置版本号的位置是头信息(HTTP Headers)，在 Accept 段中使用自定义类型(contenttype)与其他元数据(metadata)一起提交。例如:
在所有返回的响应中包含ETag头信息，用来标识资源的版本。这让用户对资源进行缓存处理成为可能，在后续的访问请求中把If-None-Match头信息设置为之前得到的ETag值，就可以侦测到已缓存的资源是否需要更新。
为每一个请求响应包含一个Request-Id头，并使用UUID作为该值。通过在客户端、服务器或任何支持服务上记录该值，它能为我们提供一种机制来跟踪、诊断和调试请求。
一个大的响应应该通过多个请求使用Range头信息来拆分，并指定如何取得。详细的请求和响应的头信息（header），状态码(status code)，范围(limit)，排序(ordering)和迭代(iteration)等，参考 Heroku PlatformAPI discussion of Ranges .
在 PUT/PATCH/POST 请求的正文（request bodies）中使用JSON格式数据，而不是使用form 表单形式的数据。这与我们使用JSON格式返回请求相对应，例如:
资源名 （Resource names）:使用复数形式为资源命名，除非这个资源在系统中是单例的 (例如，在大多数系统中，给定的用户帐户只有一个)。 这种方式保持了特定资源的统一性。
行为 （Actions）:好的末尾不需要为资源指定特殊的行为，但在特殊情况下，为某些资源指定行为却是必要的。为了描述清楚，在行为前加上一个标准的actions：
例如：
为了和域名命名规则保持一致，使用小写字母并用 - 分割路径名字，例如:
属性也使用小写字母，但是属性名要用下划线 _ 分割，以便在Javascript****中省略引号。例如：
在某些情况下，让用户提供ID去定位资源是不方便的。例如，一个用户想取得他在Heroku平台app信息，但是这个app的唯一标识是UUID。这种情况下，你应该支持接口通过名字和ID都能访问，例如:
不要只接受使用名字而放弃了使用id。
在一些有父路径/子路径嵌套关系的资源数据模块中，路径可能有非常深的嵌套关系，例如:
推荐在根(root)路径下指定资源来限制路径的嵌套深度。使用嵌套指定范围的资源。在上述例子中，dyno属于app，app属于org可以表示为：
为每一次的响应返回合适的HTTP状态码。好的响应应该使用如下的状态码:
200: GET请求成功，及DELETE或PATCH同步请求完成，或者PUT同步更新一个已存在的资源;
201: POST同步请求完成，或者PUT同步创建一个新的资源;
202: POST，PUT，DELETE，或PATCH请求接收，将被异步处理;
206: GET 请求成功，但是只返回一部分;
使用身份认证（authentication）和授权（authorization）错误码时需要注意：
401 Unauthorized: 用户未认证，请求失败;
403 Forbidden: 用户无权限访问该资源，请求失败;
当用户请求错误时，提供合适的状态码可以提供额外的信息：
422 Unprocessable Entity: 请求被服务器正确解析，但是包含无效字段;
429 Too Many Requests: 因为访问频繁，你已经被限制访问，稍后重试;
500 Internal Server Error: 服务器错误，确认状态并报告问题.
对于用户错误和服务器错误情况状态码，参考： ** **HTTP response code spec
提供全部可显现的资源表述 (例如：这个对象的所有属性) ，当响应码为200或是201时返回所有可用资源，包含 PUT/PATCH和 DELETE 请求，例如:
当请求状态码为202时，不返回所有可用资源，例如：
在默认情况给每一个资源一个id属性。除非有更好的理由，否则请使用UUID。不要使用那种在服务器上或是资源中不是全局唯一的标识，尤其是自动增长的id。
生成小写的UUID格式 8-4-4-4-12，例如：
为资源提供默认的创建时间 created_at 和更新时间 updated_at，例如:
有些资源不需要使用时间戳那么就忽略这两个字段。
仅接受和返回UTC格式的时间。ISO8601格式的数据，例如:
使用嵌套对象序列化外键关联，例如:
而不是像这样:
这种方式尽可能的把相关联的资源信息内联在一起，而不用改变资源的结构，或者引入更多的顶层字段，例如:
响应错误的时，生成统一的、结构化的错误信息。包含一个机器可读的错误 id，一个人类可读的错误信息（message），根据情况可以添加一个url来告诉客户端关于这个错误的更多信息以及如何去解决它，例如:
文档化错误信息格式，以及客户端可能遇到的错误信息id。
客户端的访问速度限制可以维护服务器的良好状态，保证为其他客户端请求提供高性的服务。你可以使用 token bucket algorithm 技术量化请求限制。
为每一个带有RateLimit-Remaining响应头的请求，返回预留的请求tokens。
请求中多余的空格会增加响应大小，而且现在很多的HTTP客户端都会自己输出可读格式（"prettify"）的JSON。所以最好保证响应JSON最小化，例如：
而不是这样：
你可以提供可选的方式为客户端提供更详细可读的响应，使用查询参数（例如：?pretty=true）或者通过Accept头信息参数（例如：Accept:application/vnd.heroku+json;version=3; indent=4;）。
提供一个机器可读的模式来恰当的表现你的API。使用 prmd 管理你的模式，并且确保用prmd verify验证是有效的。
提供人类可读的文档让客户端开发人员可以理解你的API。
如果你用prmd创建了一个概要并且按上述要求描述，你可以为所有节点很容易的使用prmd doc生成Markdown文档。
除了节点信息，提供一个API概述信息:
提供可执行的示例让用户可以直接在终端里面看到API的调用情况，最大程度的让这些示例可以简单的使用，以减少用户尝试使用API的工作量。例如:
如果你使用 prmd 生成Markdown文档，每个节点都会自动获取一些示例。
描述您的API的稳定性或是它在各种各样节点环境中的完备性和稳定性，例如：加上原型版（prototype）/开发版（development）/产品版（production）等标记。
更多关于可能的稳定性和改变管理的方式，查看 ** **Heroku API compatibility policy
一旦你的API宣布产品正式版本及稳定版本时，不要在当前API版本中做一些不兼容的改变。如果你需要，请创建一个新的版本的API。
3. API标准?
API标准--API是美国石油学会（American Petroleum Institute）的英文缩写。API建于1919年，是美国第一家国家级的商业协会，也是全世界范围内最早、最成功的制定标准的商会之一。 API背景介绍 API的一项重要任务，就是负责石油和天然气工业用设备的标准化工作，以确保该工业界所用设备的安全、可靠和互换性。制定协调标准是API最早和最成功的项目之一，自1924年发布第1个标准开始，API现在已发布了500个标准。API是ANSI认可的标准制定机构，其标准制定遵循ANSI的协调和制定程序准则，API还与ASTM联合制定和出版标准，此外，API积极参加适合全球工业的ISO标准的制定工作，是ISO/TC 671SC9井口设备和管线阀门的秘书处。 API标准应用广泛，不仅在国内被企业采用和被美国联邦和州法律法规以及运输部、国防部、职业安全与健康管理局、美国海关、环境保护署、美国地质勘查局等政府机构引用，而且也在世界范围内被ISO、国际法制计量组织和100多个国家标准所引用。 API标准主要是规定设备性能，有时也包括设计和工艺规范，标准制定领域包括石油生产、炼油、测量、运输、销售、安全和防火、环境规程等，其信息技术标准包括石油和天然气工业用EDI、通信和信息技术应用等方面。 API在美国国内以及在世界其他国家都享有很高的声望，它是美国商业部和美国贸易委员会承认的石油机械认证机构。它所制定的石油化工和采油机械技术标准被许多国家采用，中东、南美和亚洲许多国家的石油公司在招标采购石油机械时，一般都要求佩有API标志的产品才能有资格参加投标。因此，拥有API标志的石油机械设备不仅被认为是质量可靠而且具有先进水平。目前，在包括勘探和生产、运输、精炼和市场营销等各个方面拥有来自全世界的会员。今天，API已发展成为不仅在美国，而且越来越多地成为世界石油工业活动的有机组成部分。 API标志及其使用权 API会标是美国石油学会的学会产品标志，始于1924年，目的是为了鉴定生产的设备、材料，并提供能符合API质量体系和产品标准的生产企业。该标志经美国注册登记，未经许可任何人不得使用。 API取证即通过一个申请、检查、确认程序，有API向产品技术商符合API产品规范、质量管理体系（ISO9001）符合API质量纲要规范的制造厂授予证书，允许制造厂在其产品上使用API会标标志。API取证的实质是商标转让使用的授权活动。
4. API标准的介绍
API标准主要是规定设备性能，有时也包括设计和工艺规范，标准制定领域包括石油生产、炼油、测量、运输、销售、安全和防火、环境规程等，其信息技术标准包括石油和天然气工业用EDI、通信和信息技术应用等方面。 API的一项重要任务就是负责石油和天然气工业用设备的标准化工作，以确保该工业界所用设备的安全、可靠和互换性。 API是美国石油学会（AmericanPetroleumInstitute）的英文缩写。API建于1919年，是美国第一家国家级的商业协会，也是全世界范围内最早、最成功的制定标准的商会之一。 /iknow-pic.cdn.bcebos.com/9d82d158ccbf6c81fbaf3843b23eb13532fa4084"target="_blank"title="点击查看大图"class="ikqb_img_alink">/iknow-pic.cdn.bcebos.com/9d82d158ccbf6c81fbaf3843b23eb13532fa4084?x-bce-process=image%2Fresize%2Cm_lfit%2Cw_600%2Ch_800%2Climit_1%2Fquality%2Cq_85%2Fformat%2Cf_auto"esrc="https://iknow-pic.cdn.bcebos.com/9d82d158ccbf6c81fbaf3843b23eb13532fa4084"/> 扩展资料： 从API的网上名单上看，目前国内几大知名润滑油企业都榜上有名，但这与国内号称有4000余家润滑油厂商来说，获API认证的比例很不相称。 一些国有强势润滑油企业并不缺乏获API认证的技术优势，但在API的榜上无名，他们缺少的是像民营企业那样强烈的市场化意识，对消费者心理的领悟和市场动态的快速反应，习惯按照固有的模式运行。 而那些杂牌润滑油企业都意识到API认证的价值，其产品不论好赖，统统都贴上“API认证”的标签，这样能够增加卖点，增强消费者对产品的信任感。 因此，润滑油市场上就出现了“API认证”标志满天飞、消费者难辩真假的现象。实际上，API的许多低档油标准早已升级，只要按照一定路径，登录API网址就可以了解真正获得API认证的企业名单。 从国内企业获得API认证不多的现状来看，国内企业的润滑油产品大部分集中在中低档次上，高档的不多。因为如果要进军高档油领域，就必须用API标准来衡量和评价产品品质。 因此，获得API认证的过程并不难，难的是产品的技术实力能否达到API认证的要求。 参考资料：/www.people.com.cn/GB/paper1668/10138/928602.html"target="_blank"title="人民网-冒用API认证标志是违法行为">人民网-冒用API认证标志是违法行为
5. API标准的API标准应用
API标准应用广泛，不仅在国内被企业采用和被美国联邦和州法律法规以及运输部、国防部、职业安全与健康管理局、美国海关、环境保护署、美国地质勘查局等政府机构引用，而且也在世界范围内被ISO、国际法制计量组织和100多个国家标准所引用。API标准主要是规定设备性能，有时也包括设计和工艺规范，标准制定领域包括石油生产、炼油、测量、运输、销售、安全和防火、环境规程等，其信息技术标准包括石油和天然气工业用EDI、通信和信息技术应用等方面。API在美国国内以及在世界其他国家都享有很高的声望，它是美国商业部和美国贸易委员会承认的石油机械认证机构。它所制定的石油化工和采油机械技术标准被许多国家采用，中东、南美和亚洲许多国家的石油公司在招标采购石油机械时，一般都要求佩有API标志的产品才能有资格参加投标。因此，拥有API标志的石油机械设备不仅被认为是质量可靠而且具有先进水平。目前，在包括勘探和生产、运输、精炼和市场营销等各个方面拥有来自全世界的会员。今天，API已发展成为不仅在美国，而且越来越多地成为世界石油工业活动的有机组成部分。
6. API标准有那些
具体如下: 一、标准共分三大类： 1.石油设备设计及制造规范； 2.石油设备使用及维护推荐做法； 3.钻井及采油作业推荐做法。 目前，API公布了已用于API产品认证的54项产品规范。 二、API标准化政策 美国石油学会规范的出版，有利于采购标准化的材料和设备，同时也是为了制造商生产符合本会相应规范的材料或设备提供指导。这些规范不是旨在排队优良技术的需求，也不以任何方式阻碍任何人购买生产符合其它规范的产品。制定、发布API规范和API质量纲要规范，绝非旨在限制买主向未授权使用API会标的制造商购买产品。 API规范可供愿意执行规范的所有人使用。本会已做出不懈的努力，以保证其规范数据的准确性和可靠性。但是，本会对出版任何一个API规范都不表态担保和保证，并声明：凡因使用API规范而造成的损失或损坏所引起的责任和义务，API均不予以承担。 凡在自己生产的设备或材料上标有某一API规范的制造商，均有责任遵守该规范的全部条款。但API对其产品是否确实符合相应的API规范不作任何表态、担保和保证。 三、API认证介绍 1.API会标API会标是美国石油学会的学会标志。该标志经美国注册登记，未经许可任何人不得使用。 2.API取证API取证即通过一个申请、检查、确认程序，有API向产品技术商符合API产品规范、质量保证体系符合API质量纲要规范的制造厂授予证书，允许制造厂在其产品上使用API会标标志。API取证的实质是商标转让使用的授权活动。 3.API对会标的说明 (1)只授予通过API认证的制造厂 (2)不是对制造厂的担保 (3)不是对设计的赞同 (4)不是对产品的担保 (5)制造厂保证经确认的产品，每一个都符合制造时的API规范 (6)API承认制造厂在遵守制定的API标准方面受到了API的信任 四、API认证的需求 API认证从过去的潜在需求，在加入WTO的进程中，变为了显在的需求，石油机械产品的定货中，越来越注重API产品的质量认可，是由于API在石油行业的特殊地位所决定。API在美国国内及国外都享有很高的声望，它所制定的石油化工和采油机械技术标准被许多国家采用，它是美国商业部和美国贸易委员会承认的石油机械认证机构。API的认证标志在国际上也享有很高的信誉。佩带API标志的石油机械不仅被认为是质量可靠而具有先进水平，当然，价格也较高。 企业普遍反映API认证的费用太高。确实，就算是在欧美发达国家，认证也是一笔较高的投入。从很现实的角度来看，认证的费用最终是由购买者承担，企业在认证上的投入实际上应视为是产品附加值提高的技术成本投入。 中东、南美和亚洲许多国家的石油公司在招标采购石油机械时，一般都要求佩有API标志的产品才能有资格参加投标。 API对申请认证的产品不要求强制性的实验室检测，但对涉及石油、天然气的采集、加工行业的各种设备，API提出了55种详细规范。如，6D规范涉及管线阀门，包括球阀、闸阀、止回阀等。这些规范规定了产品需满足的最低要求。虽然无强制检测，但API的观察员会检查厂家递交的产品计划书，确保厂方在生产过程中执行产品规范体系。
7. api是什么标准
具体如下: 一、标准共分三大类： 1.石油设备设计及制造规范； 2.石油设备使用及维护推荐做法； 3.钻井及采油作业推荐做法。 目前，API公布了已用于API产品认证的54项产品规范。 二、API标准化政策 美国石油学会规范的出版，有利于采购标准化的材料和设备，同时也是为了制造商生产符合本会相应规范的材料或设备提供指导。这些规范不是旨在排队优良技术的需求，也不以任何方式阻碍任何人购买生产符合其它规范的产品。制定、发布API规范和API质量纲要规范，绝非旨在限制买主向未授权使用API会标的制造商购买产品。 API规范可供愿意执行规范的所有人使用。本会已做出不懈的努力，以保证其规范数据的准确性和可靠性。但是，本会对出版任何一个API规范都不表态担保和保证，并声明：凡因使用API规范而造成的损失或损坏所引起的责任和义务，API均不予以承担。 凡在自己生产的设备或材料上标有某一API规范的制造商，均有责任遵守该规范的全部条款。但API对其产品是否确实符合相应的API规范不作任何表态、担保和保证。 三、API认证介绍 1.API会标API会标是美国石油学会的学会标志。该标志经美国注册登记，未经许可任何人不得使用。 2.API取证API取证即通过一个申请、检查、确认程序，有API向产品技术商符合API产品规范、质量保证体系符合API质量纲要规范的制造厂授予证书，允许制造厂在其产品上使用API会标标志。API取证的实质是商标转让使用的授权活动。 3.API对会标的说明 (1)只授予通过API认证的制造厂 (2)不是对制造厂的担保 (3)不是对设计的赞同 (4)不是对产品的担保 (5)制造厂保证经确认的产品，每一个都符合制造时的API规范 (6)API承认制造厂在遵守制定的API标准方面受到了API的信任 四、API认证的需求 API认证从过去的潜在需求，在加入WTO的进程中，变为了显在的需求，石油机械产品的定货中，越来越注重API产品的质量认可，是由于API在石油行业的特殊地位所决定。API在美国国内及国外都享有很高的声望，它所制定的石油化工和采油机械技术标准被许多国家采用，它是美国商业部和美国贸易委员会承认的石油机械认证机构。API的认证标志在国际上也享有很高的信誉。佩带API标志的石油机械不仅被认为是质量可靠而具有先进水平，当然，价格也较高。 企业普遍反映API认证的费用太高。确实，就算是在欧美发达国家，认证也是一笔较高的投入。从很现实的角度来看，认证的费用最终是由购买者承担，企业在认证上的投入实际上应视为是产品附加值提高的技术成本投入。 中东、南美和亚洲许多国家的石油公司在招标采购石油机械时，一般都要求佩有API标志的产品才能有资格参加投标。 API对申请认证的产品不要求强制性的实验室检测，但对涉及石油、天然气的采集、加工行业的各种设备，API提出了55种详细规范。如，6D规范涉及管线阀门，包括球阀、闸阀、止回阀等。这些规范规定了产品需满足的最低要求。虽然无强制检测，但API的观察员会检查厂家递交的产品计划书，确保厂方在生产过程中执行产品规范体系。
8. 请问api测试和接口测试有何不同
API测试又称为接口测试，接口测试是功能测试的一种。 API（Application Programming Interface,应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。 API函数包含在Windows系统目录下的动态连接库文件中。Windows API是一套用来控制Windows的各个部件的外观和行为的预先定义的Windows函数。用户的每个动作都会引发一个或几个函数的运行以告诉Windows发生了什么。这在某种程度上很像Windows的天然代码。而其他的语言只是提供一种能自动而且更容易的访问API的方法。
最新文章
热门文章
推荐阅读