知识卡片

普通读书笔记卡 · 2275.as.6.f.3.c.9.b.1

API契约支持共同验证

理解等级:初级

API契约记录结构、协议、版本与方法等约定,可用OpenAPI等机器可读格式表达并用于文档和测试。消费方提供期望测试可帮助发现破坏性变更;规范文件本身仍不能替代业务语义与权限的协商。

这张卡片看不懂?

已有反馈 · 0 / 10 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    • Services and API Management · 查看原书依据

      An API or service contract is a document that captures how the API is designed (structure, protocol, version, methods, etc.) and can be used for setting up agreements between service providers and service consumers.14 A common standard for creating API contracts is the OpenAPI Specification (formerly known as the Swagger Specification). The benefit of documenting these contracts in code is that both humans and systems

    参考来源

    - 位置:《Data Management at Scale》第05章《Services and API Management》(来源项目 a19c7933-4eda-4176-aebd-30fe7e1ad292,源文件:extracted/Data Management at Scale/_epub-src/OEBPS/ch05.html) - 结论依据:原文对An API or service contract is a document的解释、约束及上下文支持本卡;内容为中文归纳,不把架构建议当作所有组织的必然规律。 - 原始内容:An API or service contract is a document that captures how the API is designed (structure, protocol, version, methods, etc.) and can be used for setting up agreements between service providers and service consumers.14 A common standard for creating API contracts is the OpenAPI Specification (formerly known as the Swagger Specification). The benefit of documenting these contracts in code is that both humans and systems