注册API是通过注册的方式，将已有的服务注册到服务平台进行统一管理。本文为您介绍如何通过注册方式生产API。
步骤一：选择生成API的方式
在Dataphin首页，选择服务 > API开发。
在左上角选择服务项目，单击左侧导航栏的API服务，在API页面，单击+新建API按钮。
在新建API对话框中，选择注册API。
步骤二：配置注册API的参数信息
在新建API页面配置参数。
参数
描述
API基础信息配置
API名称
API名称命名规则如下：
只能包含中文、字母、数字或下划线（_）。
长度为4~42个字符。
以字母开头。
全局唯一。
请求方式
API请求方式包括GET和LIST：
GET：请求服务器获取指定的某个资源。
LIST：请求服务器获取某一部分的资源。
数据更新频率
定义API返回数据的更新频率，便于调用方了解数据的时效性，支持的更新频率为每天、每小时、每分钟以及自定义，若选择自定义，支持输入不超过128个字符。
API分组
选择当前项目下配置的API分组，如需创建，请参见创建服务分组。
描述
填写对API的简单描述。128个字符以内。
协议
数据生成API的接口协议，支持HTTP、HTTPS协议。
HTTP：即超文本传输协议HTTP（HyperText Transfer Protocol），是应用最为广泛的网络协议。
HTTPS：若网关配置为阿里公有云API网关（专享实例或共享实例）时，支持选中HTTPS协议，请确保独立域名的SSL证书有效，避免无法正常调用。请通过选择平台管理网络配置，在网络配置页面，进行SSL证书配置。
超时时间
用于监控API调用的最大时长。默认为3秒，支持设置的时间范围为3到60秒的正整数。
调用API过程中如果超过了设定的超时时间，则调用API时会报错，便于您及时发现并处理调用API的异常情况。异常情况查看，详情请参见管理运维监控API。
版本号
请填写API的版本号，每份配置信息会有所属版本号，以便于和上个版本信息对比。64个字符以内。该API下版本号唯一。
返回类型
默认JSON。
后端服务配置
模式
支持Basic或Dev_Prod两种模式。
Basic模式下开发时、提交及发布线上均读取生产库。
Dev-Prod模式下开发及提交读取开发库，发布线上读取生产库。
请求方式
用于配置转发调用后端服务的请求方法，支持POST和GET。
POST：若请求方法选择POST，则请求参数支持选择BODY。
GET：若请求方法选择GET，则请求参数不支持选择BODY。
API数据源
请选择注册API的数据源，如需创建，请参见创建API数据源。
服务超时
用于监控转发调用后端服务的时长。调用后端服务过程中如果超过了设定的服务超时时间，则调用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时直接使用的参数。128字符以内。
参数位置
支持选择Headers、Parameters、Body。
Headers：在解析请求参数时会添加到参数的头部位置。
Parameters：在解析请求参数时会拼接数据源的URL。
Body：在解析请求参数时如果有多个参数，则会封装成一个Body。
参数类型
当参数位置为Headers、Parameters时，参数类型支持DOUBLE、FLOAT、STRING、DATE(yyyy-MM-dd HH:mm:ss)、BOOLEAN、INT、LONG、SHORT、BIGDECIMAL，需选择参数名对应的绑定字段的参数类型。
当参数位置为Body时，除上述参数类型外，还支持Array(int)、Array(string)和Object。
默认值
后端服务调用时，若无传值，则以默认值传入。支持输入不超过1000个字符，若参数类型为STRING，无字符输入限制。
示例
填写请求参数值的示例，便于开发者理解。支持输入不超过1000个字符。
描述
填写对请求参数的简单描述。支持输入不超过1000个字符。
是否必填
必填参数，若在调用API时不传参数值，则API调用失败。
测试
您可通过测试判断返回的响应内容是否符合预期。
配置完请求参数后，单击测试按钮，在测试请求发送对话框中，根据请求参数输入试运行值，单击开始测试按钮，系统将对请求参数进行封装，发送请求体，并返回响应内容。
返回参数
参数名
对外开放的参数，API返回时最终展示给用户的参数名称。128字符以内。
参数类型
返回参数类型包括DOUBLE、FLOAT、STRING、DATE(yyyy-MM-dd HH:mm:ss)、BOOLEAN、INT、LONG、SHORT、BIGDECIMAL、Array(int)、Array(string)11种，需选择参数名对应的绑定字段的参数类型。
示例
填写返回参数值的示例，便于开发者理解。支持输入不超过1000个字符。
描述
填写对返回参数的简单描述。支持输入不超过1000个字符。
返回参数取值路径
仅支持JSON格式，当返回数据多层嵌套，需要配置对应的返回参数路径。可单击查看配置说明， 参照示例配置返回参数的取值路径，或直接输入关键字搜索匹配路径。
单击提交，即可完成API的生成。