资讯中心

API是怎么创建的?——赛合一知识API讲堂

作为一个有态度的数据平台,【赛合一数据】旨在做最懂企业的API接口,所以今天我们就来严肃地说一说API是怎么创建起来的。

 

API 即录入 API 的定义,需要录入 API 的基本信息、服务信息、请求信息、和返回信息,然后对创建的 API 进行调试,及进行安全配置。经测试证明 API 可用后,可发布上线供用户使用。

 

首先,定义API

 

一、定义请求的基本信息

 

API 基本信息包括 API 分组、 API 名称、安全认证方式、 API 类型和描述。

 

API 分组:分组是 API 的管理单元。创建 API 之前,你需要先创建分组( API 分组的详细说明见 API 开放)。

 

API 名称:API 名称标识需在所属分组内具有唯一性。

 

安全认证方式: API 请求的认证方式,不同的平台设定的认证方式不同,详情可戳【赛合一数据】了解平台API认证。

 

API 类型:分为公开私有两种。

 

公开类型的 API——所有用户均可以在 API 网关控制台,已发布 API 页面看到 API 的部分信息。公开 类型的 API 会跟随 API 分组上架到云市场,供用户购买和调用。

 

私有类型的API——不能上架到市场中售卖。如果有用户想要调用你的私有类型的 API ,需要你主动操作授权,否则用户无渠道获取 API 信息。

 

描述: API 功能描述。

 

 

二、定义 API 请求

 

这部分是定义用户如何请求你的 API ,包括协议、请求PathHTTP Method、入参请求模式和入参定义。

 

协议:支持 HTTP HTTPS 协议。

 

请求PathPath 指相对于服务 HostAPI 的请求路径。请求 Path 可以与后端服务实际 Path 不同,你可以随意撰写合法的有明确语义的 Path 给用户使用。你可以在请求 Path 中配置动态参数,即要求用户在 Path 中传入参数,同时你的后端又可以不在 Path 中接收参数,而是映射为在 QueryHeader 等位置接收。在 开放 API 接入 API 网关 中,有详细的举例说明和操作截图展示。

 

HTTP Method支持标准的 HTTP Method,可选择 PUTGETPOSTDELETEPATCH、或 HEAD

 

入参请求模式:API 网关对入参的处理模式,支持入参映射入参透传两种模式。

 

 

三、定义后端服务信息

 

这部分主要是定义一些参数的前后端映射,即 API 后端服务的配置,包括后端服务地址、后端Path、后端超时时间、参数映射、常量参数、系统参数。用户请求到达 API 网关后,API 网关会根据你的后端配置,映射为对应的后端服务的请求形式,请求后端服务。

 

四、定义返回结果

 

录入返回 ContentType、返回结果示例、失败返回结果示例、和错误码定义。

 

 

其次,调试API

API 定义录入完成后,你可以在 API 调试页面调试 API,以确定 API 的可用性。API 创建、定义完成后,页面自动跳转到 API 列表页。你可以通过此页面按钮,测试创建的 API 是否可用,请求链路是否正确。

 

单击 API 名称或 管理 按钮,进入 API 定义 页面。

单击左侧导航栏中 调试 API

输入请求参数,单击 发送请求。

返回结果将显示在右侧页面。

如果调试返回成功结果,则说明该 API 可以使用。

如果返回代码为 4XX 5XX,则表示存在错误。

 

完成以上定义后和初步调试后,你就完成了 API 的创建。你可以发布 API 到测试、预发、线上环境,继续调试或供用户使用。还可以为 API 绑定签名密钥和流量控制等安全配置。