API 管理

可以在管理控制台中浏览 API 并管理对它们的访问。单击导航栏上的 API，查看访问 API 的文档和示例。使用端口中的设置来管理 API 的资源、用户和服务器设置。 本部分包含与管理 API 相关的主题。

​

发现

该应用程序的 API 基于 OpenAPI 规范，并且有完整的文档记录和可发现性。可以从标准 JavaScript、符合 OpenAPI 的应用程序或支持 OData 标准的任何应用程序访问 API。以下部分展示如何使用这些标准来发现 API。

​

服务文件

服务文档默认是 JSON 格式的所有 API 的简单列表。服务文档从服务根返回，所有请求都在服务根发出，包括元数据发现请求。以下是服务根的示例： http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/ 要检索更详细的信息，请向元数据 URL 发出请求。

​

元数据 URL

应用程序通过 OData 元数据文档 URL 向 OData 使用者公开其 API 的功能。元数据文档以 XML 形式返回，包含列数据类型、资源的键和其他信息。可以通过将 $metadata 附加到服务根来访问完整的元数据资源，如下例所示： http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/$metadata 要访问资源的元数据，请将 $metadata 附加到资源 URL： http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/Cars/$metadata

​

OpenAPI 定义

OpenAPI (Swagger) 定义是为通过应用程序显示的数据源生成的。 要获取 Swagger 定义，请将 $swagger 附加到服务根目录，如以下示例所示： http://MyServer:MyPort/connector/MyAPIPortName/api.rsc/$swagger

​

服务器响应

以下是对 API 资源的典型服务器响应列表，以及何时会出现此类响应的描述。

​

速率限制

可以配置每个用户的使用限制和服务器范围的默认值。有关如何配置速率限制的详细信息，请参阅默认速率限制（每用户）。

​

用户特定的限制

要配置单个用户的速率限制，请导航到用户选项卡，选择一个用户，然后单击编辑。可以配置以下选项：

• 权限：选择允许用户访问的 HTTP 方法：GET、POST、PUT/PATCH/MERGE 或 DELETE。它们分别对应于 SELECT、INSERT、UPDATE 和 DELETE 语句。
• 最大请求数：输入该用户每小时的最大请求数。值为 0 允许用户每小时无限制访问。
• 最大并发请求数：输入可以同时发送的最大请求数。值为 0 允许用户无限制并发请求。

​

跨域资源共享

可以在服务器选项卡上配置跨域资源共享 (CORS)。CORS 允许基于浏览器的客户端连接到知行之桥。如果没有 CORS，基于浏览器的脚本将无法连接到知行之桥，因为浏览器强制执行同源策略。此策略限制客户端脚本和文档加载其来源之外的资源。脚本的来源由协议、主机和端口组成。 有关如何配置 CORS 的详细信息，请参阅 CORS。