OpenAPI-Specification - REST API 标准接口


Apache
跨平台
JavaScript

软件简介

OpenAPI Specification 的目标是为 REST API
定义一个标准的、与语言无关的接口,允许人和计算机在不访问源代码、文档或通过网络的情况下发现和理解服务的功能。 通过 OpenAPI
的正确定义,消费者可以用最简答的方式理解远程服务并与其交互,消除了调用服务时的猜测。

OpenAPI不需要重写现有的API。它不需要将任何软件绑定到服务,所描述的服务甚至可能不是您的。然而,它要求在 OpenAPI Specification
的结构中描述服务的能力。不是所有的服务都可以由 OpenAPI 描述 —— 此规范并不打算涵盖 REST-ful API 的每一个可能的用例。
OpenAPI没有规定诸如设计优先或代码优先的开发过程。它通过与 REST API 建立明确的交互来促进这两种技术之一。