如何发布对外可用的API

前提条件

• 已创建应用，具体请参见添加应用。

• 已创建使用此API所需的后端逻辑流，具体操作请见编排逻辑流。

操作步骤

例如使用魔笔创建一个数据实体，并创建了一个查询该数据实体信息的后端逻辑流，希望将此后端逻辑流操作，以API的方式开放给外部第三方系统访问。具体操作步骤如下：

1. 登录魔笔。

2. 在顶部菜单栏选择应用管理，在右上角搜索框中输入目标应用，例如TEST。

3. 在指定的应用卡片中单击进入设计器，进入应用开发页面。

4. 创建数据实体，详细操作请参见新建数据模型。

   此处以创建测试用户信息为例，如下图所示：

   

5. 创建后端逻辑流。详细操作请参见编排逻辑流。

   此处以创建查询用户信息的后端逻辑流为例，如下图所示：

   

6. 在左侧功能区单击，单击触发器 > 添加触发器 > 发布API。

7. 在添加发布API页面，填写相关信息。假设您需要将开放一个查询数据库中用户信息的接口。

   1. 服务名称填写查询用户信息。

   2. 方法选择GET，操作路径配置示例为：/api/open/user/${name}。

   3. 后端逻辑流选择查询用户信息。

      

   4. 如有后端逻辑流的参数，在参数管理，添加对应参数。

      

8. 单击确定。

   说明

   以上仅为示例，实际使用API发布功能时，需要根据具体业务需求进行相关配置。

注意事项

1. 发布API功能需要进行安全配置，以防止恶意攻击和非法访问。

2. 在操作路径配置时，需要遵循RESTful API的规范，包括路径格式、请求方式等。

3. 在绑定后端逻辑流时，需要根据业务需求进行逻辑流的设计和业务逻辑的处理。

4. 在参数管理添加参数时，需要根据API的要求进行参数类型和数据类型的设置，避免参数类型错误或数据格式不符合要求。