
# 创建源系统API
源系统API可作为数据建模、数据入图时配置的数据来源。本文指导您如何新增源系统API。
#### 注意事项
为确保历史数据顺利过渡且能持续正常使用，如果您此前有使用过该功能，请按照界面上的指引完成升级操作。
#### 前提条件
已获取开发人员及以上权限用户的账号和密码。
#### 操作步骤
1. 登录LinkX-F系统首页。
2. 选择"基础数据管理 \> 源系统API"，进入"源系统API"页面。
3. 单击"创建"，弹出"创建源系统API"页面。
4. 在**表单定义** 中填写基本信息，如[表1]所示：
   
    表1基本信息 
   | 字段       | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                       |
   |:---|:---|
   | API名称    | 必填，只能包含中文、英文字母、数字、_、-，长度不能超过128个字符。                                                                                                                                                                                                                                                                                                                                                                                                      |
   | 源系统      | 必填，下拉选择/手工输入，支持联想下拉选项，来源于"基础数据管理 \> 源系统"。                                                                                                                                                                                                                                                                                                                                                                                                |
   | API URL  | 必填，选择**POST** 或**GET**请求方法并输入用于指定访问此API的URL。                                                                                                                                                                                                                                                                                                                                                                                             |
   | API描述    | 必填，长度不能超过1024个字符。                                                                                                                                                                                                                                                                                                                                                                                                                        |
   | 是否开启安全连接 | 默认值为"是"，可选"否"。 - 是：表示会校验服务端证书。此选择能保证您与网站之间建立的连接安全性，请确保服务端证书的有效性，否则可能连接测试失败。  - 否：表示不校验服务端证书。此选择无法保证您与网站之间建立的连接安全性，请勿上传输敏感信息，可能会被攻击者盗取信息。   |
      
   
   
5. 配置请求参数和响应参数。请按照使用习惯选择最适合的配置方式。 
   - **在表单定义中配置** ：通过直观地表单界面进行配置，适合需要快速设置和可视化管理的用户选择。
     表2在表单定义中配置 
     |   配置请求参数   | 配置Query参数：单击"添加"，依次输入参数名称，选择参数值类型，填写参数描述后保存。如需添加多条，可多次操作。 配置Path参数：系统会自动获取"API URL"中的参数，且支持修改。 配置Body参数：单击"添加"或在主数据操作列后单击![](https://support.huaweicloud.com/instg-idme/figure/zh-cn_image_0000002285714934.png "点击放大")，然后依次输入参数名称，选择参数值类型，填写参数描述后保存。如需添加多条，可多次操作；也可单击"基于JSON识别参数"导入JSON数据进行智能识别。 配置Header参数：单击"添加"，依次输入参数名称，选择参数值类型，填写参数描述后保存。如需添加多条，可多次操作。 |
     |---|---|
     | **配置响应参数** | 单击"添加"或在主数据操作列后单击![](https://support.huaweicloud.com/instg-idme/figure/zh-cn_image_0000002320251161.png "点击放大")，然后依次输入参数名称，选择参数值类型，填写参数描述后保存。如需添加多条，可多次操作；也可单击"基于JSON识别参数"导入JSON数据进行智能识别。                                                                                                                                                                                                                                                                                                                   |
        
     
   
   - **在YAML编辑器中编辑** ：通过编辑YAML文件来配置，适合熟悉YAML语法和OpenAPI规范，需精细控制配置的用户选择。在编辑过程中，支持随时切换**POST** 或**GET** 请求方法，单击![](https://support.huaweicloud.com/instg-idme/figure/zh-cn_image_0000002285834960.png)查看YAML参考示例，且示例可复制。编辑完成后，单击"OpenAPI规范性检查"进行规范性检查，确保API定义文件合规。
   
   
   
   
6. 调试API。 
   单击"调试"，在弹出的API调试窗口中，手动输入或引用环境变量（body参数不支持）传入各请求参数值，单击"发送请求"进行调试。
   
   
7. 调试通过后单击"保存"。
 
