# Документация API
DDB API состоит из ряда различных микросервисов. Ниже вы можете увидеть различные сервисы, с которыми вы можете взаимодействовать, наряду с тем, как аутентифицировать и получить доступ.
# Микросервисы
Наш API разделен на *6 микросервисов *Полем
| Микросервис | Цель |
|---|---|
| Экологический контекст сервис | Служба контекста окружающей среды хранит текущие данные, используемые в DDB. |
| Параметр Сервис | Услуга, предоставляющая информацию об активах и параметрах для проектов. |
| Параметр метаданные служба | Услуга, предоставляющая метаданные на активах и параметрах для проектов. |
| Справочная служба данных | Информация об исходных данных, используемая для определения ссылок на внутренние и внешние источники. |
| QA Сервис | Хост данных QA службы. |
| Комментарии Сервис | Служба комментариев предназначена для размещения резьбовых комментариев, которые связаны с различными системами, активами и параметрами. |
Каждый микросервис имеет независимый экземпляр для каждой из трех сред.
Для резюме цели каждой среды см. здесь Полем
Следующая таблица включает в себя ссылки на каждое микросервис, для каждой среды.
| Микросервис | *Разработка | Песочница | Производство |
|---|---|---|---|
| Экологический контекст службы | Environmentcontextуслуга (opens new window) | Environmentcontextуслуга (opens new window) | Environmentcontextуслуга (opens new window) |
| Параметр службы | Parameter_service (opens new window) | Parameter_service (opens new window) | Parameter_service (opens new window) |
| Параметр метаданные услуга | Parametermetadataуслуга (opens new window) | Parametermetadataуслуга (opens new window) | Parametermetadataуслуга (opens new window) |
| Справочная служба данных | reference_data_service (opens new window) | reference_data_service (opens new window) | reference_data_service (opens new window) |
| QA Сервис | Qa_service (opens new window) | Qa_service (opens new window) | Qa_service (opens new window) |
| Комментарии Сервис | Комментарии_service (opens new window) | Комментарии_service (opens new window) | Комментарии_service (opens new window) |
*Только команда разработчиков DDB должна использовать среду разработки
Все различные службы используют один и тот же базовый URL (например,https://ddb.arup.com (opens new window)) и направляются в соответствии с их URL.
Каждое микросервис определяется при использовании Open API 3.0 (Swagger). Если вы не уверены в конечных точках API, связанных с вашим процессом, свяжитесь с командой по адаптации для получения дополнительной поддержки.
# Поток API
Диаграмма ниже приводит к суммированию шагов, которые нужно предпринять при попытке получить параметры и публиковать параметры в DDB.
Требуется диаграмма вызовов API
Версии →