# API 文档

DDB API 由许多不同的微服务组成。 在下面,您可以看到可以与之互动的不同服务,以及如何进行身份验证和访问。

# 微服务

我们的 API 被隔离为 个微服务。

微服务 目的
Comments Service 主持与各种系统、资产和参数相关的线索评论。
Environment Context Service 将当前项目存储在 DDB 中,并通过 ADS 链接到更广泛的 Arup 系统。
Parameter Metadata Service 提供有关项目资产和参数的元数据。
Parameter Service 存储项目的资产和参数数据并保存 DDB 分类法。
QA Service 存储与参数和条目相关的 QA 数据。
Reference Data Service 定义对内部和外部源的引用。保存参数值的来源。
Template Service 保存可用于内容创建和自动化流程的参数和资产的模板结构。
User Service 管理项目中的用户角色以定义每个项目的访问权限。

每个微服务都有三个环境中每个环境的独立实例。

有关每个环境目的的回顾,请参阅 这里

下表包括每个环境的每个微服务的链接。

Microservice *Development Sandbox Production
comments_service comments_service comments_service
environment_context_
service
environment_context_
service
environment_context_
service
parameter_metadata_
service
parameter_metadata_
service
parameter_metadata_
service
parameter_service parameter_service parameter_service
qa_service qa_service qa_service
reference_data_
service
reference_data_
service
reference_data_
service
template_service template_service template_service
user_service user_service user_service

*只有 DDB 开发团队应使用开发环境

所有不同的服务都使用相同的基本 URL(例如https://ddb.arup.com (opens new window)),并根据其 URL 路线。

在使用 Open API 3.0(Swagger)中定义了每个微服务。 如果您不确定与流程相关的 API 端点,请联系入职团队以提供更多支持。

# 即将推出

微服务 目的
Audit Service 存储所有事件的日志并返回给定范围内的更改历史记录。

# API 流

以下图是在尝试获取和将参数发布到 DDB 时要采取的步骤。

需要的 API 呼叫图

Flow of API calls

如果您不确定将数据放在 DDB 资产层次结构中,或者缺少资产树层次结构,请联系入职团队以获得更多支持。 (opens new window)

Last Updated: 2024/8/1 14:40:59