通过注册方式创建API

步骤一：选择生成API的方式

1. 在Dataphin首页，单击顶部菜单栏服务。

   系统默认进入市场页面。

2. 按照下图操作指引，进入新建API创建方式选择对话框。

   

3. 在API创建方式选择对话框注册API后，单击确定。

步骤二：配置注册API的参数信息

1. 在新建API页面配置参数。

   

   参数	描述
   API基础信息配置
   API名称	API名称命名规则如下： 只能包含汉字、字母、数字或下划线（_）。 长度为4~42个字符。 以字母开头。 全局唯一。
   请求方式	API请求方式包括GET和LIST： GET：请求服务器获取指定的某个资源。 LIST：请求服务器获取某一部分的资源。
   API分组	选择当前项目下配置的API分组，如需创建，请参见创建服务分组。
   描述	填写对API简单的描述。128字符以内。
   协议	仅支持HTTP。HTTP即超文本传输协议HTTP（HyperText Transfer Protocol），是应用最为广泛的网络协议。 勾选HTTPS协议时，请确保独立域名的SSL证书有效，避免无法正常调用。请通过选择平台管理网络配置，在网络配置页面，进行SSL证书配置。
   超时时间	超时时间用于监控API调用的时长。调用API过程中如果超过了设定的超时时间，则调用API时会报错，便于您及时发现并处理调用API的异常情况。异常情况查看，详情请参见查看及管理运维监控API。
   版本号	请填写API的版本号，每份配置信息会有所属版本号，以便于和上个版本信息对比。64字符以内。该API下版本号唯一。
   后端服务配置
   模式	支持Basic或Dev_Prod两种模式。 Basic模式下开发时、提交及发布线上均读取生产库。 Dev-Prod模式下开发及提交读取开发库，发布线上读取生产库。
   请求方法	支持POST和GET，用于配置转发调用后端服务的请求方法。 POST：若请求方法选择POST，则请求参数支持选择BODY。 GET：若请求方法选择GET，则请求参数不支持选择BODY。
   API数据源	请选择注册API的数据源，如需创建，请参见创建API数据源。
   服务path	后端服务的调用路径。需以斜杠（/）开头，128字符以内。 例如：API数据源的URL地址为：http://88.100.19.58:*****/api/example，服务path为：/abc/djd，则后端服务的完整URL为：http://88.100.19.58:*****/api/example/abc/djd。
   服务超时	用于监控转发调用后端服务的时长。调用后端服务过程中如果超过了设定的服务超时时间，则调用API时会由于后端服务调用超时报错，便于您及时发现并处理调用API的异常情况。异常情况查看，详情请参见查看及管理运维监控API。
   请求参数
   参数名	对外开放的参数，即用户访问API时直接使用的参数。128字符以内。
   参数位置	支持选择Headers、Parameters、Body。 Headers：在解析请求参数时会添加到参数的头部位置。 Parameters：在解析请求参数时会拼接数据源的URL。 Body：在解析请求参数时如果有多个参数，则会封装成一个Body。
   参数类型	当参数位置为Body时，支持选择参数类型为Array(int)、Array(string)和Object。 当参数位置为其他时，参数类型包括DOUBLE、FlOAT、STRING、DATE(yyyy-MM-dd HH:mm:ss)、BOOLEAN、INT、LONG、SHORT、BIGDECIMAL，需选择参数名对应的绑定字段的参数类型。
   默认值	后端服务调用时，若无传值，则以默认值传入。
   示例	填写请求参数值的示例，便于开发者理解。
   描述	填写对请求参数的简单描述。
   是否必填	必填参数，若在调用API时不传参数值，则API调用失败。
   返回参数
   参数名	对外开放的参数，API返回时最终展示给用户的参数名称。128字符以内。
   参数类型	返回参数类型包括DOUBLE、FlOAT、STRING、DATE(yyyy-MM-dd HH:mm:ss)、BOOLEAN、INT、LONG、SHORT、BIGDECIMAL、Array(int)、Array(string)11种，需选择参数名对应的绑定字段的参数类型。
   示例	填写返回参数值的示例，便于开发者理解。
   描述	填写对返回参数的简单描述。
   返回参数取值路径	仅支持JSON格式，当返回数据多层嵌套，需要配置对应的返回参数路径。可点击查看配置说明。

2. 单击提交，即可完成API的生成。

后续步骤

• 生成API后，需要对API进行测试并发布至数据服务市场，便于后续应用可以调用API。具体操作，请参见测试与发布API。

• 若需要对API进行删除、版本管理、转让负责人等操作，请参见查看及管理API。