OpenAPI 规范(OAS),前身为 Swagger 规范,是全球公认的用于定义和记录 RESTful API 的标准。OpenAPI 文件作为一种与编程语言无关的接口描述,允许人类和机器在无需访问底层源代码的情况下,发现并理解 Web 服务的功能。这些文件通常使用 YAML 或 JSON 格式进行结构化,包含有关 API 端点的详细信息,包括可用操作、输入参数、输出格式、身份验证要求以及许可信息。通过使用这种格式,开发人员可以实施“API 优先”的设计方法,确保在编写任何代码之前明确定义接口。这有助于自动生成交互式文档、客户端软件开发工具包(SDK)、服务器存根(Server Stubs)以及全面的测试套件。该格式由 Linux 基金会旗下的 OpenAPI 倡议组织(OpenAPI Initiative)维护,已成为现代 Web 开发的行业标准,实现了不同系统之间的无缝集成,并显著改善了前端和后端工程团队之间的协作效率。