谷云科技API集成开发平台使用指南

需积分: 23 3 下载量 14 浏览量 更新于2024-07-06 收藏 4.07MB PDF 举报
"API集成开发平台场景使用说明书v4.0.pdf" 提供了关于如何在谷云科技的API集成开发平台上进行各种API发布和管理的详细指导。 ### API集成开发平台简介 谷云科技(广州)有限责任公司的API集成开发平台是一个低代码开发工具,允许用户快速链接外部数据源,创建并发布API,以实现不同系统间的数据交换和集成。这个平台简化了API的开发流程,特别适合于需要高效集成和管理API的企业或开发者。 ### 链接外部数据源 1. **使用须知**:在链接外部数据源前,用户需了解平台的兼容性、权限设置和安全策略。 2. **新建Rdbs关系数据库(链接池)**:平台支持创建Rdbs链接池,用于连接到不同的数据库,例如MySQL、Oracle等。 3. **测试数据源**:创建后,可以通过平台提供的测试功能验证数据源连接的正确性和可用性。 ### 创建API集成开发平台应用分类 1. **业务场景**:应用分类是组织和管理API的一种方式,可以根据实际业务需求创建。 2. **创建应用分类**:用户可以自定义分类,便于管理和查找相关API。 3. **创建应用**:在应用分类下创建应用,每个应用可包含一组相关的API。 ### 创建实体模型 1. **业务场景**:实体模型用于表示业务中的对象,如用户、订单等。 2. **创建实体模型**:根据业务需求,设计并构建实体模型,包括字段定义、数据类型和关系。 3. **导出实体模型数据**:完成模型后,可以导出数据以便其他系统使用。 ### 发布API 1. **业务场景**:发布API以供外部系统调用,实现数据交互。 2. **发布API**:基于实体模型,平台提供一键发布API的功能。 3. **测试API**:发布后,平台提供测试工具,确保API功能正常。 4. **字段配置**:包括隐藏字段、字段ID替换、返回值半隐藏等,满足不同安全和隐私需求。 ### 其他API发布方式 1. **通过业务模型发布API**:适用于更复杂的数据处理场景,通过业务逻辑模型创建API。 2. **通过脚本发布API**:允许用户编写自定义脚本来实现特定功能。 3. **通过JavaBean发布API**:支持JavaBean对象,方便进行键值对、路径或JSON参数的传递。 4. **通过存储过程发布API**:利用数据库存储过程,处理复杂的数据库操作。 5. **通过Eclipse发布API**:对于高级开发者,可以用Eclipse等IDE配合平台插件进行API开发。 ### 总结 API集成开发平台v4.0提供了一套全面的工具,涵盖了从数据源链接、API设计、发布到测试的全过程。无论是低代码的简单操作,还是针对特定业务场景的定制化开发,都能在该平台上高效地完成,极大地提升了API开发的效率和灵活性。