所有文章 > 当前标签:OpenAPI

OpenAPI 3.0 规范全面解析
2025/01/24
OpenAPI 3.0规范是现代API开发的基础工具,通过标准化描述RESTful API,增强了开发、测试及维护的效率。OpenAPI对象是规范的核心,定义基本信息如版本和描述。Info对象提供API的标题、描述和版本等信息。Servers对象支持多服务器配置,方便在不同环境中使用。Paths对象定义API路径和操作,Components对象则允许重用公共参数和响应。Security对象支持多种认证方式,Tags对象则助于分组管理API路径。此外,ExternalDocs对象可引用外部资源,丰富文档信息。

原型优先API设计
【API设计】
API 设计方法的讨论通常分为两大阵营:代码优先和设计优先。每种方法都有不同的权衡,设计优先通常被认为是理想的,但并不总是实用的。在本文中,我将提出第三种选择,即原型优先,并论证了它结合了其他两种方法的多种优点。
2024/12/05

为什么API开发对现代应用至关重要?
【API开发】
本博客将为您全面解析API及其在现代应用开发中的核心价值。此外,我们还将深入探讨API在将网站与应用程序与不同服务器链接时所扮演的关键角色。API已成为现代Web开发中不可或缺的一部分,本博文将详细阐述API如何为应用程序开发带来诸多益处。
2024/11/29

接口大师v3.10.0 零代码/低代码,把内部接口变成OpenAPI开放接口的妙招
【API使用场景】
如果原来已经有一批内部的API接口,现在需要调整成对外开放的API接口,有没快速的办法,能即刻实现?最好是当天就能部署上线,对外开放使用的解决方案?选择合适的工具和解决方案,能快速实现你想要的效果,并且最快当天就能上线。
2024/11/25

云服务OpenAPI的7大挑战,架构师如何应对?
【API开发】
API 是模块或者子系统之间交互的接口定义。好的系统架构离不开好的 API 设计,而一个设计不够完善的 API 则注定会导致系统的后续发展和维护非常困难。比较好的API设计样板可以参考 github 和 k8s ,它们都是典型的RESTful接口。云服务对外开放的窗口就是OpenAPI,今天要讨论的话题是“云服务场景下OpenAPI设计的挑战”。
2024/11/19

如何实现 OpenAPI 多语言 SDK 开发?
【API开发】
通过 Darabonba 对 OpenAPI 进行描述,其本质就是统一了元数据,只是这个元数据并不是 JSON 或者 Yaml 这样的方式来描述的,而是通过 DSL 代码来描述。Darabonba 的编译器则会将 Darabonba 的 DSL 代码转化为 AST,通过 OpenAPI 描述转化而来的 AST 不仅包含了 OpenAPI 的信息,而且还包含整个 OpenAPI 的流程性描述,所以我们只需要通过 AST 开发对应的各语言SDK就可以生成多语言的 SDK了。
2024/11/19

有哪些新闻媒体提供Open API?
【日积月累】
新闻媒体行业一直在寻求通过技术手段提高报道的覆盖面和互动性,而开放API(Open API)正是实现这一目标的关键工具之一。开放API允许开发者访问新闻内容、元数据和其他服务,从而创建新的应用和服务。本文将介绍一些提供Open API的新闻媒体,并分析它们的特点和适用场景。
2024/11/18

用于高效API文档和开发的顶级OpenAPI工具
【API开发工具】
本文深入分析了优化API工作流程的关键OpenAPI工具,以及它们如何显著增强API的管理能力。这些工具为API从设计到发布的每一个环节都提供了全面的解决方案。了解如何充分利用这些工具,将帮助您的团队优化开发流程,确保API的高质量交付与可扩展性。
2024/11/09

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

动态应用程序安全 测试(DAST)工具 概述和指南
【技术杂货铺】
动态应用程序安全测试(也称为 DAST)是一种测试应用程序运行版本以识别潜在安全漏洞的方式。
2024/09/23

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

为什么你不应该忽略内部API文档的重要性
【API设计】
优秀的文档可让您的团队了解每个 API 的功能并快速上手。这是更大规模 API 设计管理流程的一个重要成果。实施后,您的内部 API 文档可为您的团队提供即时和长期价值。
2024/09/13

API治理:有效API管理的最佳实践和策略
【API生命周期】
API 治理是一个复杂且多方面的过程,涉及多个关键组件,包括安全性、技术、合规性、利用率、监控、性能和教育。通过在这些领域中实施最佳实践,组织可以确保他们的 API 既安全又高效,符合相关规范,并能为用户提供最大价值。
2024/09/11

API 发现:你需要了解的一切
【API生命周期】
在本博客中,我们将探讨 API 发现的基础知识,包括其含义、识别已记录和隐藏 API 的技术以及发现对于安全性和效率的重要性。
2024/09/06

使用 OpenAPI 和 Prism 模拟回调
【API开发】
回调是服务为响应某个操作而向其他服务发出的传出异步请求。它们与 JavaScript 等流行编程语言中的回调函数非常相似。但它们是在 API 抽象级别执行的。
2024/09/06

如何编写 API 文档:最佳实践和示例
【API开发】
什么是 API 文档?应该如何编写?应该包含哪些内容?最佳实践是什么?本文将回答这些问题,并提供一些创建 API 文档的最佳实践。
2024/08/29
搜索文章