# Dokumentasi API
API DDB terdiri daripada beberapa microservices yang berbeza. Di bawah ini anda dapat melihat perkhidmatan yang berbeza yang boleh anda berinteraksi, bersama -sama dengan cara mengesahkan dan mendapatkan akses.
# Microservices
API kami dipisahkan *6 Microservices *.
| Microservice | Tujuan |
|---|---|
| Perkhidmatan Konteks Alam Sekitar | Perkhidmatan Konteks Alam Sekitar menyimpan data projek semasa yang digunakan dalam DDB. |
| Perkhidmatan Parameter | Perkhidmatan yang memberikan maklumat mengenai aset dan parameter mengenai projek. |
| Parameter Metadata Service | Perkhidmatan yang menyediakan metadata mengenai aset dan parameter pada projek. |
| Perkhidmatan Data Rujukan | Maklumat data sumber yang digunakan untuk menentukan rujukan kepada sumber dalaman dan luaran. |
| Perkhidmatan QA | Hos data perkhidmatan QA. |
| Komen Perkhidmatan | Perkhidmatan Komen dimaksudkan untuk menganjurkan komen berulir yang berkaitan dengan pelbagai sistem, aset dan parameter. |
Setiap microservice mempunyai contoh bebas untuk setiap tiga persekitaran. Untuk rekap tujuan setiap persekitaran, lihat di sini .
Jadual berikut termasuk pautan ke setiap microservice, untuk setiap persekitaran.
| Microservice | *Pembangunan | Kotak pasir | Pengeluaran |
|---|---|---|---|
| Perkhidmatan Konteks Alam Sekitar | persekitaran_context_perkhidmatan (opens new window) | persekitaran_context_perkhidmatan (opens new window) | persekitaran_context_perkhidmatan (opens new window) |
| Perkhidmatan Parameter | parameter_service (opens new window) | parameter_service (opens new window) | parameter_service (opens new window) |
| Perkhidmatan metadata parameter | parameter_metadata_perkhidmatan (opens new window) | parameter_metadata_perkhidmatan (opens new window) | parameter_metadata_perkhidmatan (opens new window) |
| Perkhidmatan data rujukan | rujukan_data_service (opens new window) | rujukan_data_service (opens new window) | rujukan_data_service (opens new window) |
| Perkhidmatan QA | qa_service (opens new window) | qa_service (opens new window) | qa_service (opens new window) |
| Komen Perkhidmatan | Comments_service (opens new window) | Comments_service (opens new window) | Comments_service (opens new window) |
*Hanya pasukan pembangunan DDB yang harus menggunakan persekitaran pembangunan
Semua perkhidmatan yang berbeza menggunakan URL asas yang sama (mis.https://ddb.arup.com (opens new window)) dan dialihkan mengikut url mereka.
Setiap microservice ditakrifkan dalam menggunakan API Open 3.0 (swagger). Jika anda tidak pasti titik akhir API yang berkaitan dengan proses anda hubungi pasukan onboarding untuk lebih banyak sokongan.
# Aliran API
Diagram di bawah adalah meringkaskan langkah -langkah untuk diambil ketika cuba mendapatkan dan menyiarkan parameter ke DDB.
Rajah panggilan API diperlukan
Versi →