# OpenAPI

> OpenAPI 是 REST API 的标准机器可读描述，涵盖端点、参数、架构和错误，可据此生成类型化客户端库、文档和 API 工具集合。

YAML 或 JSON 格式的 OpenAPI 文件会精确描述每个端点，供工具生成 TypeScript、Python 或 Java 客户端，导入 Postman 或 Insomnia，验证请求或呈现参考文档。对于小型 API，它可以完全取代官方 SDK，并通过构建流程与 API 保持同步。

它也是 AI 编程助手正确集成 API 时最有用的资料。

在 SMSMeteor：OpenAPI 3.1 描述位于 [/docs/openapi.yaml](https://smsmeteor.com/zh/docs/openapi.yaml)，并随 API 版本管理；生成方法见 [SDK 页面](https://smsmeteor.com/zh/docs/sdks)。

相关术语：[REST API（SMS）](https://smsmeteor.com/zh/glossary/rest-api)、[API 密钥](https://smsmeteor.com/zh/glossary/api-key)

---
来源：[HTML 页面](https://smsmeteor.com/zh/glossary/openapi)。由 SMSMeteor 使用与页面相同的数据生成。[全站摘要](https://smsmeteor.com/zh/llms.txt)