- 综合排序
- 最热优先
- 最新优先
- 来自专栏程序人生
再谈 API 的撰写 - 契约
现代社会是个契约社会，生活中大大小小的事情都在和契约打交道。去奥莱买件衣服，一纸小票，便是你跟商家的契约：你花钱买到了产品，产品的问题商家会承诺处理（退换货）。 有副作用的函数尽管有诸多含混不清的地方，任然不失为一种契约。 函数级别的契约的所有当事人都是程序员，契约更新的影响面有限，所以遇到问题，姐弟俩一商量，改！新的契约就出现了。 然而，新的契约出现并不意味着旧的契约的终止，只有当所有使用旧契约的地方都改用新契约时，我们才能安全地废除旧契约。 REST API（以下凡提到 API，都指 REST API）是什么？REST API 是服务器和客户端之间的契约。这就意味着一个中小规模的 API，其 CEI 起码在 0.1 以上。 然而，API 写得再好，没有一个与之对应的契约，是万万不行的 —— 没有文档描述的 API 就如同没有说明书的产品。文档和代码，如同泉水干涸之后相呴以湿，相濡以沫的鱼儿，谁也离不开谁。
1.8K80发布于 2018-03-28 - 来自专栏NetCore
.NET 4特性聚焦：代码契约
在某些方面，契约 看上去类似断言，不过它们本质上存在非常大的区别。契约通过静态代码分析的组合来实现，它能被用于编译器内部和外部，以及测试框架之中。 而通过附加契约，开发人员和工具都可以知道“GetDescription要求输入一个正整数并返回一个不能为空的字符串”。 除了显式的契约之外，契约检查器也支持隐式的契约。一个例子就是被零除这样的情况。 对于非关联化空值 和数组索引也存在一些隐式契约。 为了让契约设计更容易，还存在一个ObjectInvariant方法的概念。 这允许客户端开发人员在利用由函数库开发人员创建的契约时，还是能使用更快的发布编译版本。 一个更有趣的特性是契约不仅仅能应用于实际的函数，甚至没有其他实现细节的接口和抽象方法也能拥有契约。 关于.NET 4中的契约的更多信息，可以仔细阅读PDC主旨发言的前半部分。 查看英文原文：.NET 4 Feature Focus: Code Contracts
91950发布于 2018-02-01 - 来自专栏测试技术圈
契约测试
系统的可靠性等于各个依赖服务的可靠性的乘积 也就是说:A服务的可靠性是99%，B服务的可靠性是99%，C服务 的可靠性是99%，如果⼀一个系统需要A调⽤用B，B调⽤用C，那么这个 系统的可靠性=0.99*0.99*0.99=0.9702 契约是规定得到多 ⽅方承认、信守的内容 契约测试是验证服务的Provider是否按照期望的⽅方式与服 务的Consumer进⾏行行交互，简单的说是Consumer与Provider两者之间的集成。 契约测试是以消费者提出接⼝口契约，交由服务提供⽅方实现，并以测试⽤用例例对 契约进⾏行行产⽣生约束，所以服务提供⽅方在满⾜足测试⽤用例例的情况下可以⾃自⾏行行更更改 接⼝口或架构实现⽽而不不影响消费者。 契约测试是⼀一种针对外部服务的接⼝口进⾏行行的测试，它能够验证服务是否满⾜足 消费⽅方期待的契约。 它的本质是从利利益相关者的⽬目标和动机出发，最⼤大限 度地满⾜足需求⽅方的业务价值实现。
95440发布于 2019-08-02 - 来自专栏FunTester
契约测试
契约测试 契约测试（contract test）第一次出现在Martin Fowler的一篇文章中。 只需要在满足测试需求的范围内，对于被测系统来说，确保测试替身提供的API与依赖组件提供的一样即可，API具体怎么实现的并不重要。 契约测试从消费者的角度定义测试，通过给API提供方提供契约，实现功能。 契约测试的核心原则是由消费者提出接口契约，由服务提供方实现，并用测试用例对契约进行约束，所以服务提供方在满足测试用例的情况下可以自行更改接口或架构实现而不影响消费者。 然而，在以下场景下目前并不适合应用Pact这类契约测试实践： 在测试过程中，代码需要调用公共API或者OAuth授权服务； 提供者端和消费者端没有良好的沟通渠道； 对提供者端进行功能性测试；
63430编辑于 2023-08-04 - 来自专栏ThoughtWorks
浅谈契约测试
为了解决这类的问题，契约测试应运而生。契约测试不是一个新鲜东西，但在实际项目经历中发现用好契约测试真的会大大增强开发的效率，因此写下这篇文章来简单总结一下契约测试的一些内容。 首先什么是契约测试 契约测试是一个为确保两个独立的系统或者微服务能够兼容并可以相互通信的一个方法，契约测试分为两种，一种是服务提供者驱动的，另一种是消费者驱动的。 契约测试形式上类似于API级别的UT，但其本质上还是个集成测试，比API测试在金字塔的位置更靠顶端，所以容易导致契约测试的数量增加和不稳定性增加。 在这种情景下，提供者驱动的契约测试更加适合。由服务的提供方来约定契约，然后众多的消费者去满足契约，当提供方发生变动时，消费方能够及时感知到并快速反馈。 发现问题后可以快速定位到问题： 因为问题只会出现在当前测试的服务或者组件中，你甚至可以确切的知道是哪个api测试fail了 4.
1.3K10编辑于 2022-07-26 - 来自专栏测试技术圈
实战契约测试
“ 消费者驱动契约测试对于API或微服务开发非常重要，它解耦了API提供者和消费者间的开发与测试过程。” API或微服务间的集成测试不容易，且成本高昂。 基于以上痛点，契约测试应运而生，它解耦了API提供者和消费者间的开发与测试过程。双方只需要约定对API接口的期望（假设提供者收到怎样的请求会产生怎样的响应）并通过一份“契约”把它固化下来。 其大致过程为： API消费者与提供者约定契约； Spring Cloud Contract的Maven/Gradle Plugin会自动根据契约生成JUnit的测试程序，供API提供者来测试其行为是否满足契约的预期 ； API提供者完成开发，通过第2步的测试来验证； API提供者通过Spring Cloud Contract的Maven/Gradle Plugin根据契约生成Stub，它将模拟API提供者的行为供消费者调用来测试 验证Stub 当契约准备好后，我们可以在API服务者端通过mvn install -DskipTests来生成Stub。
1.1K30发布于 2019-08-02 - 来自专栏贾维斯Echo的博客
Go 接口-契约介绍
Go 接口-契约介绍 一、接口基本介绍 1.1 接口类型介绍 接口是一种抽象类型，它定义了一组方法的契约，它规定了需要实现的所有方法。 is %T\n", v4) 你可以看到，这个例子的输出结果与我们之前讲解的是一致的。 和生活工作中的契约有繁有简，签署方式多样一样，代码间的契约也有多有少，有大有小，而且达成契约的方式也有所不同。 更倾向于“小契约”：这点也不难理解。你想，如果契约太繁杂了就会束缚了手脚，缺少了灵活性，抑制了表现力。 显然，我们会选择那些新接口类型需要的契约职责，同时也要求不要引入我们不需要的契约职责。
48350编辑于 2023-11-07 - 来自专栏ThoughtWorks
使用契约测试得不偿失？试试契约先行开发
消费方回去写自己的契约测试，生成契约 (通常以 OpenApi doc 形式)，然后以契约测试驱动，开发自己的逻辑 服务方拿到生成的契约，进行测试驱动开发，验证契约是否被满足 契约测试有时修改代价高 更重要的是，随着测试的编写，生成的契约可能比当时商讨的更为简单，比如一些 400, 401 等情况，有时并不会为每一个 API 写足够细节足够详尽的测试；也可能生成的契约比商讨的更为详细，比如消费方在编写契约测试的过程中考虑到了更多的边缘场景 因而每当由以上情况导致修改契约时，我们都会重新沟通，再等待消费方重新写契约测试，再生成契约，然后服务提供方再开发。 契约先行模式下，团队的沟通闭环 这样以来，团队的合作流程如下： 消费方与提供方沟通，达成契约，并在契约代码库中一起提交契约代码，即 OpenAPI doc。然后触发流水线，生成各方代码 sdk。 契约先行的适用场景 契约先行开发并非银弹，它在解决特定场景下的问题时，才更“划得来”。 比如契约应简单直接。
50720编辑于 2023-04-28 - 来自专栏老齐教室
开源的社会契约
我们应该认识到，开源是一种社会契约。 法律契约 从什么是开源软件谈起，我认为： ★开源软件就是源代码，其许可方式是：用户可以免费使用。 ” 开源项目除了提供源代码之外，还有别的义务吗？
50840发布于 2021-05-20 - 来自专栏cnblogs
restful Api 风格契约设计器：Swagger-editor和swagger-ui的应用
swagger-ui的安装 展示swagger-editor生成的api文档，api文档格式可以是yaml或json。 ) { connect.server({ root: 'dist', livereload: true, port:8888 }); }); 可以增加打印功能，用于导出api
1.9K90发布于 2018-01-17 - 来自专栏大内老A
WCF技术剖析之十四：泛型数据契约和集合数据契约（下篇）
从下面的XML的结构和内容中，我们可以总结出下面3条规则： 根节点的名称以ArrayOf为前缀，后面紧跟集合元素类型对应的数据契约名称； 集合元素对象用数据契约的命名空间作为整个集合契约的命名空间 因为Customer是一个数据契约，IEnumerable<Customer>、IList<Customer>与Customer[]只能算是数据契约的集合，其本身并不算是一个数据契约。 而通过自定义集合类型，我们可以将集合整体定义成一个数据契约，我们基于集合的数据契约称为集合数据契约（Collection Data Contract）。 图4 添加服务引用时指定字典集合类型 自定义字典数据契约类型 在上面，我们通过CollectionDataContractAttribute特性实现了自定义集合数据契约，我们同样可以通过该特性自定义字典类型的集合数据契约 （上篇） WCF技术剖析之十四：泛型数据契约和集合数据契约（下篇） WCF技术剖析之十五：数据契约代理（DataContractSurrogate）在序列化中的作用 WCF技术剖析之十六：数据契约的等效性和版本控制
2K70发布于 2018-01-16 - 来自专栏python爱好部落
实现接口的契约测试
解决方案 解决方式首先是依赖关系的解耦，去掉直接对外部API的依赖，而是内部和外部系统都依赖于一个双方共同认可的约定—“契约”，并且约定内容的变化会被及时感知；其次，将系统之间的集成测试，转换为由契约生成的单元测试 这样，同时契约替代外部API成为信息变更的载体 契约测试也叫消费者驱动测试。 两个角色：消费者（Consumer）和 生产者（Provider） 一个思想：需求驱动（消费者驱动） 契约文件：由Consumer端和Provider端共同定义的规范，包含API路径，输入，输出。 我们可以通过SCHEMA来实现接口的契约测试。 API测试：通过FAKER生成测试数据，通过SCHEMA检查返回结果 ? image 需求 假定有如主图相同的http请求。 4.运行测试主入口文件，打印一下发送的json文件，看是不是随机化了，结果是确实随机化了。 ? 代码 测试主入口test_json_from_schema.py #!
1.8K10发布于 2020-09-24 - 来自专栏walterlv - 吕毅的博客
C#.NET 中的契约
然而除非是专门提供 SDK 的团队，否则文档通常都会滞后于代码，那么对于这些契约的修改可能就不太准确。 于是，契约式编程就应运而生。 几种不同的契约方法 ReSharper Annotations ReSharper 并没有将其称之为“契约”，因为它真的只是“文档级别”的约束，只会在写代码的时候具备一定程度的静态分析能力以便给出提示， 只要是装了 ReSharper 插件并用它写过代码的，应该都见过 ReSharper Annotations 了，因为它会在我们试图添加契约代码时自动添加契约标记（Attribute）。 Roslyn Roslyn 相比于任何第三方契约的优势在于它甚至能在语法层面形成契约（比如 C#8.0 中的可空引用类型）。 在实际应用中，并没有严格的说哪一个更好哪一个一般，两者都可以用，只要我们有分析和提示此契约的工具，就可以在项目中推行开来。 但是，基于契约编写代码的模式却能帮助我们写出更加健壮的代码来。
1.4K10发布于 2018-09-18 - 来自专栏全栈程序员必看
mt4数据api接口_外汇api
1、MT4API交易接口是什么？ MT4Api接口是跨平台多账号交易接口，是将MT4交易通道以API的方式聚合在一起，帮助开发商在各经纪商不提供manager后台账号、无须EA插件的情况下，也能轻松接入不同的MT4交易平台，完成登录、交易和订单查询的功能 2、MT4API的协议传输方式 MT4 API接口是基于MT4的底层通讯格式，进行模拟信息传输的方式实现了实时通信，这不仅摆脱了MT4系统的限制，能够通过搭建第三方环境来实现和券商服务器通信，还摆脱了券商 相对 MT4 本身的交易客户端， MT4API 提供更快速的访问实时价格行情和交易访问连接。 4、MT4 API提供了哪些业务功能？ MT4API交易接口跟随迈达克的更新而更新的，一年在约有一到两次的更新频率，一旦更新，有些MT4平台还可以使用，如果MT4服务商也同步更新完，则对应的MT4平台账号则无法使用，对应的软件需要同步更新MT4API
3.8K22编辑于 2022-09-30 - 来自专栏学而时习之
【Elasticsearch】4. Search API
Search API URI Search：在URL中使用查询参数 Request Body Search：使用Elasticsearch提供的，基于json格式的更加完备的Query Domain Speacific filtering image (3).png 如果_source 没有存储，那就只返回匹配的文档的元数据 _source 支持使用通配符 脚本字段 eg：订单中有不同汇率，需要对不同汇率进行结算排序 image (4)
81650发布于 2020-12-15 - 来自专栏开始入门
契约优先与协作效率——消费者驱动契约思维带来的团队成本下降
传统的提供者驱动契约（Provider-Driven Contracts）模式下，API设计由服务提供方主导，消费者只能被动适应。这种模式存在几个关键问题：集成测试滞后导致问题发现晚、修复成本高。 提供者担心破坏现有消费者而不敢进行必要的API优化，导致接口日益臃肿且难以维护。一项调查显示，75%的团队因担心破坏集成而推迟API改进。文档与实现脱节增加沟通成本。 静态API文档往往落后于实际实现，消费者基于过时文档开发只会增加集成失败风险。这种不一致性导致大量不必要的跨团队沟通和误解。 、高级治理高DreddOpenAPI优先API文档驱动验证低Pact是目前最流行的CDC框架，支持10+编程语言，提供完整的契约测试、代理和可视化功能。 4 团队协作效率的提升机制4.1 沟通成本的量化下降CDC通过标准化协作接口显著降低了团队间的沟通成本。传统模式下，接口变更需要会议、文档、邮件等多轮沟通。
15110编辑于 2026-01-15 - 来自专栏悠扬前奏的博客
MyBatis-4.Java API
注意联合映射在注解API中是不支持的。这是因为Java注解的限制,不允许循环引用。 @Many N/A <collection> 映射到复杂类型的集合属性。 注意 联合映射在注解 API中是不支持的。这是因为 Java 注解的限制，不允许循环引用 @MapKey 方法 这是一个用在返回值为 Map 的方法上的注解。
1.1K40发布于 2019-05-30 - 来自专栏大内老A
WCF技术剖析之十二：数据契约（Data Contract）和数据契约序列化器（DataContractSerializer）
一、数据契约 一个正常的服务调用要求客户端和服务端对服务操作有一致的理解，WCF通过服务契约对服务操作进行抽象，以一种与平台无关的，能够被不同的厂商理解的方式对服务进行描述。 与数据契约的定义相匹配，WCF采用新的序列化器——数据契约序列化器（DataContractSerializer）进行基于数据契约的序列化于反序列化操作。 同服务契约类似，WCF采用了基于特性（Attribute）的数据契约定义方式。 与之类似，数据契约也采用这种显式声明的机制。 二、数据契约序列化器（DataContractSerializer） 在WCF中，数据契约的定义是为序列化和反序列化服务的。
2.1K90发布于 2018-01-16 - 来自专栏啄木鸟软件测试
Spring Boot+cucumber+契约测试
在“依赖项”对话框中搜索并添加“web”依赖项，为了后面的契约文件，再加入“Config Client ”和“Contract Stub Runner依赖项。 >spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project> 3 目录结构如下 4 io.cucumber.java.zh_cn.那么; import io.cucumber.junit.platform.engine.Cucumber; import org.junit.jupiter.api.Assertions springframework/cloud/contract/verifier/tests/ContractVerifierTest.java中产生 import org.junit.jupiter.api.Test ; import org.junit.jupiter.api.extension.ExtendWith; import io.restassured.module.mockmvc.specification.MockMvcRequestSpecification
40010编辑于 2024-09-10 - 来自专栏大内老A
WCF技术剖析之十四：泛型数据契约和集合数据契约（上篇）
Artech.DataContractSerializerDemos 2: { 3: [DataContract(Namespace="http://www.artech.com/")] 4: OrderBillDetail> CreateOrderBill() 2: { 3: OrderBillHeader header = new OrderBillHeader 4: namespace Artech.DataContractSerializerDemos 2: { 3: [DataContract(Name="OrderHeader")] 4: namespace Artech.DataContractSerializerDemos 2: { 3: [DataContract(Name="OrderBill")] 4: 1: namespace Artech.DataContractSerializerDemos 2: { 3: [DataContract] 4: public class
1.6K90发布于 2018-01-16
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号