创建源系统API

操作场景

源系统API可作为数据建模、数据入图、数据服务时配置的数据来源。本文指导您如何新增源系统API。

前提条件

已获取开发人员及以上权限用户的账号和密码。

操作步骤

1. 登录LinkX-F系统首页。
2. 选择“基础数据管理 > 源系统API”，进入“源系统API”页面。
3. 单击“创建”，弹出“创建源系统API”页面。
4. 填写基本信息，如表1所示：

   表1 基本信息

   字段	说明
   API类型	必填，下拉选择API类型： 普通API：代表无外键依赖的实体数据API，包括源端API和对象实体API。 外键依赖API：代表外键依赖的实体数据API。 纯关系API：代表至少存在两个外键依赖的关系API，用于展示关系实体中的源端和目标端实体关联关系。
   API名称	必填，不能重复，不能包含特殊字符，只支持中文、字母、数字以及下划线，长度不能超过128个字符。
   源系统	必填，下拉选择/手工输入，支持联想下拉选项，来源于“基础数据管理 > 源系统”。
   API URL	必填，手工输入，用于指定访问此API的URL。
   请求方式	必填，下拉选择，用于指定访问此API的请求方式。
   API描述	必填，可包含中文、英文、数字、特殊字符和空格，长度不能超过1024个字符。
   Swagger内容	必填，手工输入。此内容可以用于解析API输入参数和输出参数。Swagger入参参数中最多支持写入10个业务参数。 单击“填写示例”查看不同API类型的Swagger内容填写模板，可复制粘贴至编辑框中修改。

5. 请求头配置。

   如需配置请求头，请填写key值和value值，单击“新增请求头”可添加多条。

6. API参数映射配置。

   选择不同的“API类型”，需要填写的必填的语义参数有所不同。

   • 从“Swagger入参”处拖动字段至“API入参”对应字段后的填写框中。
   • 从“Swagger出参”处拖动字段至“API出参”对应字段后的填写框中。

7. 选择是否开启安全连接。默认值为“是”，可选“否”。
   • 是：表示会校验服务端证书。此选择能保证您与网站之间建立的连接安全性，请确保服务端证书的有效性，否则可能连接测试失败。
   • 否：表示不校验服务端证书。此选择无法保证您与网站之间建立的连接安全性，请勿上传输敏感信息，可能会被攻击者盗取信息。

8. 填写完成后单击“连接测试”。
9. 多次调试直至测试通过后单击“保存”。