所有文章 > 当前标签:OpenAPI

OpenAPI 和 JSON Schema:何时使用哪个
2025/10/11
许多组织都有由 JSON Schema 描述的现有对象。但问题是,开发人员遇到了一个大问题:OpenAPI仍然无法识别和支持某些 JSON Schema 关键字。

企业如何从 OpenAPI 规范中受益
【API解决方案】
尽管 OpenAPI 规范对于 API 行业以外的人来说并不是一个熟悉的术语,但它是一项影响着每个使用它的人的技术。OAS 框架为开发人员提供了一个参考点,用于协作、创造性和可测试的 API 设计。这提升了开发人员的工作体验,进而使他们更有能力为最终用户打造一流的API产品。
2025/10/10

Arazzo:OpenAPI 的工作流扩展规范
【API设计】
Arazzo 是 OpenAPI 倡议推出的一项新规范,旨在描述和记录 API 中涉及多个操作的复杂工作流。通过声明式的语法,Arazzo 能够清晰地定义操作的输入、输出和步骤,支持复杂的条件判断和引用机制,为 API 文档和测试提供强大支持。
2025/10/04

OpenAPI驱动的API设计
【API设计】
OpenAPI 规范是设计 API 的最著名方法之一。OAS 指定了描述 API 接口所需的规则和语法。在撰写本文时,我们使用的是 OAS 的第三个版本。
2025/09/30

使用Redocly进行API文档编写:将OpenAPI规范转换为HTML
【API开发工具】
本文详细介绍了如何使用Redocly工具将OpenAPI规范转换为HTML文档,提升API文档的可读性和可访问性。内容包括安装Redocly CLI工具、创建OpenAPI规范文件、转换为HTML文档的具体步骤,以及转换后的文档优势。
2025/09/23

PI 优先设计(API Design-First)全面解析
【API设计】
API优先设计是一种在编码前先定义API接口的开发方法,旨在通过先规划API合同来确保团队成员对API的理解一致。随着技术的发展,OpenAPI和AsyncAPI分别成为REST API和事件驱动API的描述标准,显著简化了API生命周期。文章回顾了API设计优先的发展历程,从早期的WSDL和SOAP到现代的OpenAPI和AsyncAPI,并探讨了其优势、工具以及设计优先与代码优先的对比。
2025/09/21

OpenAPI 规范创建指南|优化 API 设计的 10 个关键要点
【API设计】
本文详细介绍了OpenAPI规范的基本概念及其在API设计中的重要性,包括如何通过10个关键要点来优化API设计。这些要点涵盖了从编写清晰的API标题到定义错误响应模式的各个方面,旨在帮助开发者创建更易于理解和使用的OpenAPI规范。
2025/09/20

OpenAPI & AsyncAPI 标签指南:高效组织与优化API文档
【API设计】
本文详细介绍了如何利用OpenAPI和AsyncAPI标签功能高效组织和分类API端点,提升API文档的结构和可读性。通过示例展示了标签的定义和应用,以及标签排序、使用外部文档链接等技巧,强调了标记所有端点、避免重复标签等最佳实践。
2025/09/18

使用README风格的API文档提升您的API设计
【API设计】
本文探讨了使用README风格的API文档如何提升API设计,通过关注用户实际工作流而非单个操作,显著提升API的可用性和用户体验。文章介绍了OpenAPI规范的基础,传统API文档的局限性,以及如何实施README风格的文档,包括确定用户工作流、提供代码示例和与现有工具集成。
2025/09/14

如何在API中使用和记录多态 – Bump.sh
【API设计】
本文探讨了在API开发中应用和记录多态性的方法,通过减少重复代码来提升API的可维护性和灵活性。文章通过住宿租赁系统的示例展示了如何利用多态性设计通用端点,简化API结构,并详细介绍了在JSON Schema、OpenAPI和AsyncAPI规范中记录多态性的关键方法。
2025/09/10

安全好用的OpenApi
【API安全】
一、AppId和AppSecret AppId的使用 AppId作为一种全局唯一的标识符,其作用主要在于方便用户身份识别以及数据分析等方面。为了防止其他用户通过恶意使用别人的AppId来发起请求,一般都会采用配对AppSecre...
2025/08/29

什么是OpenAPI?
【API术语解释】
OpenAPI也称为OpenAPI规范(OpenAPI),可帮助开发人员在涉及多个协议、接口和环境时简化应用程序开发。它通过提供一个可以访问数据的单一界面来实现这一点。
2025/08/26

Amazon Bedrock AgentCore Gateway:2025 Swagger 零门槛 API 职教 OpenAPI 自动化实战
【API开发工具】
引言:当 API 遇见 Generative AI 我们正处在一个由API(Application Programming Interface)驱动互联的时代。微服务、云原生和无处不在的集成让API的数量和复杂性呈指数级增长。与此同时,Ge...
2025/08/25

API架构设计基础
【API设计】
本文详细介绍了API架构设计的基础知识,包括核心组件如数据模型、端点、身份验证和授权等,以及设计API架构的关键步骤和最佳实践。通过OpenAPI等工具标准化API文档,确保客户端应用程序的性能和安全性。API架构设计是现代软件开发的关键,能够加速应用程序开发并提高系统健壮性。
2025/08/22

面向API技术文档作者的Git工作流 – Bump.sh
【API生命周期】
本文探讨了技术编写人员如何通过Git工作流和自动化工具保持API文档与API设计的同步。文章介绍了使用Git工作流的好处、通过代码生成文档的挑战及解决方案,以及独立存储库的优势,旨在帮助技术作者更高效地管理API文档。
2025/08/20

15 个值得尝试的 API 设计工具
【API设计】
本文介绍了15款高效的API设计工具,包括Postman、SoapUI、SwaggerHub等,涵盖从设计到测试的全流程解决方案。这些工具能帮助开发者优化API开发流程,提升团队协作效率,适合不同规模和技术栈的开发团队。
2025/08/08