知识卡片

普通读书笔记卡 · 3215.a

OpenAPI描述接口形状

理解等级:中级

OpenAPI 用 JSON 或 YAML 表达接口结构、交换对象和安全要求,还能附上元数据、文档与示例。共享这份规范使消费者在实现前看到端点形状,也为生成客户端、校验消息和发现兼容性变化提供同一个输入。

这张卡片看不懂?

已有反馈 · 0 / 10 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    • · 查看原书依据

      The OpenAPI Specifications are JSON- or YAML-based representations of the API that describe the structure, the domain objects exchanged, and any security requirements of the API. In addition to the structure, they also convey metadata about the API, including any legal or licensing requirements, and also carry documentation and examples that are useful to developers consuming the API.

    参考来源

    - 位置:《Mastering API Architecture》第1章《Design, Build, and Specify APIs》之《Specifying REST APIs Using OpenAPI》(源文件:_epub-src/OEBPS/ch01.xhtml) - 结论依据:原文把 OAS 定义为承载结构、领域对象、安全要求及文档示例的可共享表示,并指出围绕它形成工具生态。 - 原始内容:The OpenAPI Specifications are JSON- or YAML-based representations of the API that describe the structure, the domain objects exchanged, and any security requirements of the API. In addition to the structure, they also convey metadata about the API, including any legal or licensing requirements, and also carry documentation and examples that are useful to developers consuming the API.