How to Design APIs with Description Languages
SOAP-based APIs are described with Web Services Description Language (WSDL).
REST-based APIs can be created with the following main description languages:
- RAML
- OpenAPI
In an API First Approach, only the provided APIs are of interest.
在 API 优先方法中,只有所提供的 API 才是重点关注对象。
By using standardized communication protocols and concepts, such as REST and OData, almost any use case can be mapped across all borders.
通过使用标准化的通信协议和概念,如 REST 和 OData,几乎任何用例都能跨越所有界限进行映射。
Communication takes place between an API provider who has the interface available and the API consumer who consumes this interface.
通信发生在拥有可用接口的 API 提供者和使用该接口的 API 使用者之间。
The APIs are described with standardized description languages, such as RAML or OpenAPI.
API 是用标准化的描述语言来描述的,如 RAML 或 OpenAPI。
The implementation can be created at first at the API provider and then at the description (implementation - first approach based on it) or the other way round by first creating the description and then automatically creating server and client stubs from it (contract - first approach).
实现方式可以是先在 API 提供者端创建实现,然后生成描述(基于此的实现优先方法),或者反过来,先创建描述,然后从中自动生成服务器和客户端存根(契约优先方法)。
We see that SOAP APIs, OData 2.0, and 4.0 APIs, as well as SAP Graph play the leading role in the SAP universe.
我们看到,SOAP API、OData 2.0 和 4.0 API 以及 SAP Graph 在 SAP 领域中发挥着主导作用。